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 sessionslists sessions,odette sessions homethe homes,odette gatesboth gate modes,odette daemonthe daemon’s status. --profile <name>works with a launch,odette shell,login,logoutandprofiles key.--show-checksand--quietwork only with a launch andodette shell.odette helpandodette completionwork beforeodette setup.odette completion <shell>prints a completion script forbash,zsh,fishorpowershell. 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.
Launching
Section titled “Launching”odette
Section titled “odette”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 |
Sessions
Section titled “Sessions”odette attach [name] [-- command...]
Section titled “odette attach [name] [-- command...]”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.
odette sessions
Section titled “odette sessions”List running sessions (name, project, profile, worktree, pod, role, state, ports), stop them, and manage their Claude homes
odette sessions home
Section titled “odette sessions home”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.
odette sessions home list
Section titled “odette sessions home list”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
odette sessions home prune
Section titled “odette sessions home prune”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 |
odette sessions home reset <project>
Section titled “odette sessions home reset <project>”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 |
odette sessions home rm <project>
Section titled “odette sessions home rm <project>”Delete a project’s home in every profile; refuses while a session uses any of them
| Flag | Does |
|---|---|
-y, --yes |
Delete without asking |
odette sessions list
Section titled “odette sessions list”List every running session across all projects
odette sessions stop <name>
Section titled “odette sessions stop <name>”Stop a running session, from any folder; its Claude home is kept
odette shell [-- command...]
Section titled “odette shell [-- command...]”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 |
Gates and dashboard
Section titled “Gates and dashboard”odette dashboard
Section titled “odette dashboard”Start the daemon if needed, print the dashboard address and open it in the browser
odette dashboard cert
Section titled “odette dashboard cert”Print the dashboard certificate’s path, creating it if needed; safe to trust
odette dashboard password
Section titled “odette dashboard password”Set the dashboard password; signs out every browser
odette gates
Section titled “odette gates”Show the Commands and Egress gate modes, the dashboard’s Gates panel
odette gates commands [mode]
Section titled “odette gates commands [mode]”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 |
odette gates egress [mode]
Section titled “odette gates egress [mode]”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 |
odette policy
Section titled “odette policy”Print the organization’s Claude Code policy in force, where it comes from and what it restricts
odette rules
Section titled “odette rules”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.
odette rules commands rm <command>
Section titled “odette rules commands rm <command>”Stop allowing a command in a folder
| Flag | Does |
|---|---|
--dir |
The folder the command was allowed in (needed only when several folders allow it) |
odette rules egress add <host>
Section titled “odette rules egress add <host>”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) |
odette rules egress rm <host>
Section titled “odette rules egress rm <host>”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) |
odette rules github rm <repo>
Section titled “odette rules github rm <repo>”Stop odette reading a repository with your GitHub login, in every scope
odette rules list
Section titled “odette rules list”List the allowed commands, the egress rules and the GitHub logins
Profiles
Section titled “Profiles”odette login
Section titled “odette login”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) |
odette logout
Section titled “odette logout”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 |
odette profiles
Section titled “odette profiles”List profiles and each one’s sign-in state
odette profiles key
Section titled “odette profiles key”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 |
odette profiles key list
Section titled “odette profiles key list”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 |
odette profiles key rm <service>
Section titled “odette profiles key rm <service>”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 |
odette profiles key set <service>
Section titled “odette profiles key set <service>”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 |
odette profiles rm <name>
Section titled “odette profiles rm <name>”Delete a profile: its sign-in, service keys and Claude homes; refuses while a session uses it
| Flag | Does |
|---|---|
-y, --yes |
Delete without asking |
Projects
Section titled “Projects”odette build
Section titled “odette build”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 |
odette init
Section titled “odette init”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 |
odette kit
Section titled “odette kit”Apply reusable project setups: toolchains, plugins, egress hosts, standards
odette kit add <source>
Section titled “odette kit add <source>”Register a kit repository (a git source), pinned to the commit fetched
| Flag | Does |
|---|---|
--name |
Name for the repository (default: derived from the source) |
odette kit apply [kit...]
Section titled “odette kit apply [kit...]”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 |
odette kit detach <kit>...
Section titled “odette kit detach <kit>...”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 |
odette kit list [repo]
Section titled “odette kit list [repo]”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.
odette kit rm <repo>
Section titled “odette kit rm <repo>”Forget a registered kit repository
odette kit update [kit...]
Section titled “odette kit update [kit...]”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 |
odette marketplace
Section titled “odette marketplace”Add, remove and list the plugin marketplaces sessions use, and switch their plugins on and off
odette marketplace add <source>
Section titled “odette marketplace add <source>”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) |
odette marketplace list
Section titled “odette marketplace list”List every marketplace sessions in this project use, and the file declaring it
odette marketplace plugins <name>
Section titled “odette marketplace plugins <name>”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 |
odette marketplace rm <name>
Section titled “odette marketplace rm <name>”Remove a marketplace
| Flag | Does |
|---|---|
--global |
Edit config.json: every project on this machine |
--local |
Edit .odette/marketplaces.local.json: this project, this machine |
odette mount
Section titled “odette mount”Add, remove and list the host folders mounted into this project’s sessions
odette mount add <path>
Section titled “odette mount add <path>”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) |
odette mount list
Section titled “odette mount list”List every declared mount, the file declaring it, and whether the next launch mounts it
odette mount rm <path>
Section titled “odette mount rm <path>”Stop mounting a host path
| Flag | Does |
|---|---|
--shared |
Remove it from .odette/mounts.json only |
Setup and maintenance
Section titled “Setup and maintenance”odette clean
Section titled “odette clean”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 |
odette config
Section titled “odette config”Show and change odette’s settings and feature flags; in a terminal, pick flags with checkboxes
odette config get [key]
Section titled “odette config get [key]”Show one setting or flag; with no key, all of them with defaults
odette config set <key> <value>
Section titled “odette config set <key> <value>”Change a setting in ~/.odette/config.json. Keys and accepted values:
backend docker | apple (ODETTE_BACKEND overrides it)log_level DEBUG | INFO | WARN | WARNING | ERRORmcp_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.
odette daemon
Section titled “odette daemon”Manage the host-side daemon (proxy, gates, dashboard)
odette daemon restart
Section titled “odette daemon restart”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 |
odette daemon start
Section titled “odette daemon start”Start the daemon in the background
odette daemon status
Section titled “odette daemon status”Show whether the daemon runs and passes its health checks; exits non-zero if not
odette daemon stop
Section titled “odette daemon stop”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 |
odette setup
Section titled “odette setup”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.
odette update
Section titled “odette update”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 |
odette version
Section titled “odette version”Print the odette version