SextantDocs
v2.4latest
v2.4latestv1.9legacy

Switching keeps you on the same page when it exists in the other version.

On this page

tokens, webhooks, logs and more

Reference for the operational commands: tokens, webhooks, logs, inspect, config, migrate, login and init.

Updated CLI reference Version v2.4

tokens

Shell
sextant tokens create --name ci-deploy --scope jobs:write --expires-in 90d
sextant tokens list
sextant tokens revoke tok_71c0de
sextant tokens bootstrap --config sextant.toml

create takes --scope more than once. bootstrap talks to the store directly, so it works when you have lost every token; run it on the server with the same config. Scopes are listed in Tokens and scopes.

webhooks

Shell
sextant webhooks create https://hooks.example.com/sextant --events job.failed,job.dead
sextant webhooks list
sextant webhooks test whk_5d02ab
sextant webhooks delete whk_5d02ab

See Webhooks for events and signatures.

logs

Streams structured logs from the server over HTTP, so you do not need access to its container.

Shell
sextant logs --follow --queue emails --level warn --since 10m
--follow, -fboolean optional
Keep the stream open.
--queuestring optional
Only lines about this queue.
--jobstring optional
Only lines about this job id.
--levelstring optional default info
Minimum level.
--sinceduration optional
Start this far back.

inspect

Prints a job with its full attempt timeline. See Observability for sample output.

Shell
sextant inspect job_8f3k2m9q
sextant inspect job_8f3k2m9q --output-lines 200   # show more of each attempt's output

config

Shell
sextant config check --config sextant.toml
sextant config print --config sextant.toml

check validates the file and exits 2 on errors, so it belongs in CI. print shows the effective configuration after defaults, environment variables and flags are applied, with secrets masked.

migrate

Shell
sextant migrate up --config sextant.toml           # apply store migrations
sextant migrate status --config sextant.toml       # list applied and pending
sextant migrate config --from sextant.yaml --to sextant.toml
sextant migrate from-v1 --redis redis://localhost:6379/0 --dry-run

from-v1 is covered in Migrating from v1.

login and init

sextant login --url <url> --name <profile> asks for a token (input is hidden) and saves the profile. sextant init writes a commented starter sextant.toml; it refuses to overwrite an existing file unless you pass --force.