Skip to content

Commands

Every command and flag, generated from the binary: odette <command> --help prints the same text.

The commands follow the dashboard: sessions, the Commands and Egress gates, profiles, then project setup and maintenance.

  • A command that groups others, typed on its own, runs its most informative subcommand: odette sessions lists sessions, odette sessions home the homes, odette gates both gate modes, odette daemon the daemon’s status.
  • --profile <name> works with a launch, odette shell, login, logout and profiles key. --show-checks and --quiet work only with a launch and odette shell.
  • odette help and odette completion work before odette setup.
  • odette completion <shell> prints a completion script for bash, zsh, fish or powershell. It completes session, profile, marketplace, kit and home project names, declared mount paths, setting keys and their values from what is on your machine.

For the why and the how around each command, see Sessions, Approvals, Configuration and Security.

Start a Claude Code session in the current project, in a container whose only way out is odette’s proxy on your machine.

Arguments after – go to claude: continue the last conversation with odette – –continue, or pick one with odette – –resume.

Flag Does
--mount-ro Mount a host path read-only at the same path inside the container (repeatable)
--mount-rw Mount a host path read-write at the same path inside the container (repeatable)
--pod Join a pod: sessions with the same pod name can message each other
--profile The profile (account) to launch under; without it the only signed-in profile is used, or you are asked
--prompt First prompt for Claude Code
--publish Publish a container port on the host’s 127.0.0.1: PORT or HOST:PORT (repeatable)
--quiet Print only warnings and errors
--role Role within the pod (e.g. “hub”); needs –pod. supervisor asks you to confirm
--show-checks Print every startup check (image freshness, Claude Code version) and its outcome
--skip-version-check Don’t update Claude Code at launch
-w, --worktree Work in the git worktree name; without one, it is named after the session. Needs at least one commit

Run a shell, or a command, inside a running session’s container, in the project root. Without a name it uses the session running for the current project. It shares the agent’s container, so use it for a dev server that reloads on the agent’s edits; for a clean, separate container use odette shell -- command.

List running sessions (name, project, profile, worktree, pod, role, state, ports), stop them, and manage their Claude homes

Manage the Claude homes (one per profile and project) and overlay folders odette keeps on your machine. <project> is the project’s path, even if the folder is gone, or the home’s folder name. No home command touches a home a running session uses.

List every home and overlay folder with its size, last use, sessions and status (ok, orphaned, incompatible)

odette sessions home mv <old-path> <new-path>

Section titled “odette sessions home mv <old-path> <new-path>”

Reassign a project’s homes and overlay folders after its folder moved

Delete orphaned homes, homes unused for a while, or both; skips homes in use

Flag Does
-n, --dry-run Print what would be deleted without deleting
--older-than Prune homes unused for longer than this (e.g. 30d, 2w, 12h)
--orphans Prune homes and overlay folders whose project folder is gone
-y, --yes Delete without asking

Delete everything in a project’s home, in every profile, except conversations and memory; defaults return at the next launch

Flag Does
-y, --yes Reset without asking

Delete a project’s home in every profile; refuses while a session uses any of them

Flag Does
-y, --yes Delete without asking

List every running session across all projects

Stop a running session, from any folder; its Claude home is kept

Start a new container for this project and open a bash shell, or run a command, in it, without Claude Code. It is separate from any running session; to run a command beside the agent, use odette attach -- command.

Flag Does
--profile The profile (account) to run under; without it the only signed-in profile is used, or you are asked
--publish Publish a container port on the host’s 127.0.0.1: PORT or HOST:PORT (repeatable)
--quiet Print only warnings and errors
--show-checks Print every startup check (image freshness, Claude Code version) and its outcome

Start the daemon if needed, print the dashboard address and open it in the browser

Print the dashboard certificate’s path, creating it if needed; safe to trust

Set the dashboard password; signs out every browser

Show the Commands and Egress gate modes, the dashboard’s Gates panel

Show or set the commands gate. Without –session this is the global mode.

With –session <name>, set that session’s own mode for this gate, as the dashboard’s per-session select does; “inherit” makes the session follow the global mode again. A session’s override lives in the running daemon, so this needs the daemon.

Flag Does
--session Set this session’s mode instead of the global one; needs the daemon

Show or set the egress gate. Without –session this is the global mode.

With –session <name>, set that session’s own mode for this gate, as the dashboard’s per-session select does; “inherit” makes the session follow the global mode again. A session’s override lives in the running daemon, so this needs the daemon.

Flag Does
--session Set this session’s mode instead of the global one; needs the daemon

Print the organization’s Claude Code policy in force, where it comes from and what it restricts

The dashboard’s Rules zone, from the command line: the commands you allowed in a folder, the hosts allowed, denied or inspected for egress, and the repositories odette may read with your GitHub login.

Granting stays in the dashboard’s approvals; a host can also be added here. The Inbox and Activity stay in the dashboard.

Stop allowing a command in a folder

Flag Does
--dir The folder the command was allowed in (needed only when several folders allow it)

Allow a host for this project (–global: every project), or deny or inspect it

Flag Does
--deny Use the deny list
--global Use the list for every project instead of this project’s
--inspect Use the inspected-hosts list (machine-wide)

Remove a host rule from this project (–global: every project)

Flag Does
--deny Use the deny list
--global Use the list for every project instead of this project’s
--inspect Use the inspected-hosts list (machine-wide)

Stop odette reading a repository with your GitHub login, in every scope

List the allowed commands, the egress rules and the GitHub logins

Sign a profile in to Claude

Flag Does
--claude-home The host folder this profile’s claude CLI keeps its sign-in in (e.g. ~/.claude-work), not a project’s Claude home; remembered for later logins
--from-claude-cli Import the token pair the host claude CLI is already signed in with, without running a login
--paste Use the paste-the-code flow instead of the loopback redirect
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked
--token Paste an Anthropic API key instead of signing in (skips OAuth)

Forget a profile’s Claude credentials

Flag Does
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked

List profiles and each one’s sign-in state

Manage a profile’s service API keys (gemini)

Flag Does
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked

List which services a profile has an API key for

Flag Does
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked

Remove a profile’s API key for a service

Flag Does
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked

Set a profile’s API key for a service, read from standard input

Flag Does
--profile The profile (account) to use; without it the only signed-in profile is used, or you are asked

Delete a profile: its sign-in, service keys and Claude homes; refuses while a session uses it

Flag Does
-y, --yes Delete without asking

Rebuild the base and project images, reusing the build cache. Every 30 days the next build, or the next launch that rebuilds, starts from scratch with a fresh base image, so packages in the image do not fall behind. –no-cache forces that full rebuild now.

Flag Does
--claude-code-version Install and pin this Claude Code version (default: the latest, not pinned)
--no-cache Full rebuild: skip the layer cache and pull the base image

Create .odette/ in this project, optionally applying kits

Flag Does
--kit Apply this kit after creating .odette/ (repeatable)
-y, --yes With –kit, confirm the change without asking

Apply reusable project setups: toolchains, plugins, egress hosts, standards

Register a kit repository (a git source), pinned to the commit fetched

Flag Does
--name Name for the repository (default: derived from the source)

Applies each kit after the kits it includes, shows the complete change — including any egress host it adds — and writes only after you confirm. Without –yes a non-interactive run writes nothing. With –global only a kit’s marketplaces and domains are applied, to the machine. With –once nothing is recorded in kits.lock, so kit update never touches what was written; a kit already in the lock is refused (see kit detach).

Flag Does
--global Apply only the kits’ marketplaces and egress hosts, to the machine
--once Apply without recording the kits in kits.lock, so kit update never touches them
-y, --yes Confirm the change without asking

Removes the named kits from kits.lock so kit update no longer touches them. No file, block or marker is changed: what the kits wrote stays as it is, and applying a kit again still rewrites its blocks. Lists the kits first and asks; without a terminal it changes nothing unless you pass –yes.

Flag Does
--global Detach kits applied to the machine
-y, --yes Confirm without asking

List kits in every repository (the built-in “odette” one and each registered one), or only in <repo>. Each row shows the kit as <kit>@<repo>, whether this project has applied it, its version and its name.

Forget a registered kit repository

Fetches the newest commit of each registered repository an applied kit comes from, then re-applies those kits, showing the change. Only kits listed in kits.lock are touched. The first update in a project with pre-kit odette:toolchain blocks migrates them.

Flag Does
--global Update the kits applied to the machine
-y, --yes Confirm the change without asking

Add, remove and list the plugin marketplaces sessions use, and switch their plugins on and off

Add a marketplace (GitHub owner/repo, git URL or local folder)

Flag Does
--global Edit config.json: every project on this machine
--local Edit .odette/marketplaces.local.json: this project, this machine
--plugins Plugins to enable, added to those already enabled (default: pick from the marketplace’s manifest)

List every marketplace sessions in this project use, and the file declaring it

Show which plugins of a marketplace are enabled, disabled and merely offered, or switch plugins on (–enable) and off (–disable). A disabled plugin stays off when a kit that declares it is applied again.

The entry is edited in whichever file declares it; pass –local or –global when both of those do.

Flag Does
--disable Plugins to switch off, and keep off when a kit is applied
--enable Plugins to enable, added to those already enabled
--global Edit config.json: every project on this machine
--local Edit .odette/marketplaces.local.json: this project, this machine

Remove a marketplace

Flag Does
--global Edit config.json: every project on this machine
--local Edit .odette/marketplaces.local.json: this project, this machine

Add, remove and list the host folders mounted into this project’s sessions

Mount a host folder or file into every session of this project

Flag Does
--rw Mount read-write (default read-only)
--shared Edit .odette/mounts.json, committed with the project (default .odette/mounts.local.json: this project, this machine)

List every declared mount, the file declaring it, and whether the next launch mounts it

Stop mounting a host path

Flag Does
--shared Remove it from .odette/mounts.json only

Remove containers, volumes, session networks, images, Claude homes, overlay folders, activity history and daemon logs.

Kept: settings (config.json), profiles and their credentials, egress lists and the command allowlist (allow.csv).

The daemon must not be running. Stop it first with: odette daemon stop

It lists what it will remove and asks first; –yes skips the question, and a run with no terminal needs it. When there is nothing to remove it says so and does not ask.

Flag Does
-n, --dry-run Print what would be removed without removing
-y, --yes Skip the confirmation prompt

Show and change odette’s settings and feature flags; in a terminal, pick flags with checkboxes

Show one setting or flag; with no key, all of them with defaults

Change a setting in ~/.odette/config.json. Keys and accepted values:

backend docker | apple (ODETTE_BACKEND overrides it)
log_level DEBUG | INFO | WARN | WARNING | ERROR
mcp_port 1–65535 (default 7902)
web_port 1–65535 (default 7900)
proxy_port 1–65535 (default 7901)
default_timeout integer >= 0 (seconds; 0 = no timeout)
approval_timeout integer >= 0 (seconds; default 300)
heartbeat_interval integer >= 1 (seconds; default 15)
feature.<name> on | off (applies at once; status_row and pod_clear change what new sessions get; names: odette config get)

Settings apply when the daemon next starts. Gate modes: odette gates.

Manage the host-side daemon (proxy, gates, dashboard)

Stop the daemon and start it again from the binary you run now. Like “daemon stop” it lists running sessions and asks first. The new daemon takes its environment from this shell, so ODETTE_YOLO and ODETTE_JUDGE here decide the gate modes it starts with.

Flag Does
-y, --yes Restart without asking

Start the daemon in the background

Show whether the daemon runs and passes its health checks; exits non-zero if not

Stop the daemon. Running sessions lose their proxy and gates while it is down, so a stop with sessions running lists them and asks first; –yes skips the question, and a run with no terminal needs it. Sessions on both container backends are counted when the backend can be read; one that cannot is named in a warning.

Flag Does
-y, --yes Stop without asking

One-time setup: container backend, SSH key, certificates, dashboard password and Claude sign-in, then suggested marketplaces and kits. Safe to re-run: it asks before changing what is already set, and is also where you pick another SSH key. When a command needs a step that is missing, odette runs that step by itself.

Update odette to the latest release (needs the gh CLI signed in)

Flag Does
--check Only check for a newer release; do not download or install

Print the odette version

Theme