Skip to main content

​
kagi redirect

Manage Kagi search redirect rules from the terminal.

​
Synopsis

​
Authentication

Required: KAGI_SESSION_TOKEN Redirect management uses Kagi’s authenticated settings pages.

​
Rule Format

Rules must use Kagi’s current regex|replacement format.

​
Subcommands

​
kagi redirect list

List redirect rules.

​
kagi redirect get <ID_OR_RULE>

Fetch one redirect rule by id or exact rule text.

​
kagi redirect create <RULE>

Create a redirect rule.

​
kagi redirect update <ID_OR_RULE> <RULE>

Update a redirect rule by id or exact rule text.

​
kagi redirect enable <ID_OR_RULE>

Enable a redirect rule.

​
kagi redirect disable <ID_OR_RULE>

Disable a redirect rule.

​
kagi redirect delete <ID_OR_RULE>

Delete a redirect rule.

​
Output Contract

list returns an array of summaries:
get, create, and update return full rule details:
enable and disable return:
delete returns:

​
Examples

Create a redirect rule, verify it, then enable it:
Inspect only enabled rules:

​
Notes

  • Targets may be the numeric redirect id or the exact rule text.
  • The CLI validates that rule bodies are non-empty and use the regex|replacement form before sending them.

​
See Also