Using the CLI

The oktapod command for quick questions, checks, scripts, and headless servers.

oktapod is installed with Oktapod. It talks to the same agent as the web and phone apps, with the same memory, approvals, and records. Nothing you do in the terminal skips a rule that would apply in chat.

Use it when you are on a server without a screen, when you want to script something, or when a quick command is faster than opening the app.

#Getting help

oktapod help
oktapod approvals --help
oktapod version

For Oktapod's own commands, help is answered before anything else runs, so adding --help to a command you are learning is safe. The low-level browser, nodes, devices, cron, and system commands pass their arguments straight to the running agent; use their top-level help. Many commands accept --verbose for more detail and --json for scripts; check a command's help before relying on either.

#Everyday commands

Ask something:

oktapod chat "What needs my attention today?"

Open the web app on this computer, with the access key handed over once:

oktapod ui --open

oktapod ui without --open prints the address and key instead. The key is only printed to a terminal, or when you pass --print-key or --json.

Answer approvals:

oktapod approvals pending
oktapod approvals approve <approval_id> --reason "Checked"
oktapod approvals deny <approval_id> --reason "Not now"

Get today's brief and search memory:

oktapod brief --refresh
oktapod memory search "where I prefer to work"

#Start, stop, and check

If something is wrong, start with oktapod checkup. It names the problem and the command that fixes it. See Troubleshooting.

#See what happened

Every run leaves a record. From the terminal:

oktapod runs tail
oktapod timeline <run_id>
oktapod decision <run_id>
oktapod inspect <run_id>

runs tail lists recent actions and their outcomes. timeline shows one run step by step, decision shows why it was allowed, and inspect shows the full context.

#Set up and connect

oktapod onboard
oktapod setup email
oktapod setup calendar
oktapod auth status
oktapod channels status
oktapod models status --verbose

See First run, Connect your apps, and Messaging channels.

#Scripting

• Use --json when a command's help lists it, and parse that. The normal human output can change between versions.
• A request that needs approval stops at an approval, exactly as it would in chat. There is no flag that skips approvals.

The full list of commands is in the CLI reference.