9. Command & Flag Reference

This chapter is a pure reference—every omicos command and flag gathered into tables for quick lookup.

9.1 Command Tree

omicos
├── serve              HTTP daemon + browser UI (the default when no subcommand is given)
├── cli                terminal TUI chat + embedded daemon
│   ├── chat           interactive chat (cli's default subcommand)
│   └── login          device-code pairing login (terminal, authorize from another device)
├── login              email / password login (terminal, no browser needed)
└── env
    ├── setup          install / repair the Python analysis environment
    └── doctor         diagnose Python and kernel availability

9.2 serve Flags

Flag Type Default Description
--host string 127.0.0.1 Bind address
--port u16 5055 HTTP port
--data-dir path .omicos Workspace data directory
--upstream-base-url string no default for serve Fallback target for the local /api/* proxy (cloud-sync escape hatch); env OMICOS_UPSTREAM_BASE_URL. Does not enable the cloud relay (the relay is determined by the process_token you log in with)
--kernel-base-url string none Remote IPython kernel address; env OMICOS_KERNEL_BASE_URL; setting it skips local environment bootstrapping
--no-browser flag off (i.e. the browser opens by default) Don't open the browser automatically (bare switch)
--debug bool (with value) false Enable debug logging; must be written as --debug true, not a bare switch
--log-filter string none tracing filter expression; env OMICOS_LOG_FILTER

9.3 cli Flags

cli reuses all of serve's daemon flags (but with different defaults, see below), and adds chat flags on top:

Daemon flags (default differences):

Flag cli default
--data-dir .omicos/cli (serve uses .omicos)
--upstream-base-url https://auth.omicos.cn (serve has no default; both can be overridden by env OMICOS_UPSTREAM_BASE_URL)

In cli mode stdout is taken over by the TUI, so --debug / --log-filter are unavailable—use the RUST_LOG environment variable instead.

Chat flags (ChatArgs):

Flag Type Description
--process string Connect to a specific cloud process (e.g. a remote HPC node)
--session string Resume a specific session (defaults to resuming the most recently active session)
--new flag Force a new session

9.4 login Flags

Flag Default Description
--server https://auth.omicos.cn Authentication service address
--email (interactive prompt) Email
--password (interactive prompt) Password
--name (taken from the conda env name or directory name) Process display name
--force off Force re-authentication even if already logged in
--status off Only check login status, print it, and exit
--logout off Log out and delete credentials

9.5 cli login Flags

Flag Default Description
--server https://auth.omicos.cn Authentication service address (device-code flow only)
--logout off Log out

9.6 env Flags

Subcommand Flag Description
env setup --force Re-run uv sync even if the environment already exists
env setup --yes Non-interactive, auto-confirm
env doctor (no flags) Diagnose and print environment information

9.7 serve vs cli Default Comparison

Dimension serve cli
--data-dir .omicos .omicos/cli
--upstream-base-url no default for serve https://auth.omicos.cn
Logging method --debug true / --log-filter / RUST_LOG RUST_LOG only
Process identifier local-<workspace_id> local-<workspace_id>-cli
Interface browser SPA + optional dashboard terminal TUI

Nearly every flag has a corresponding environment variable that can override it; for the full list, see Chapter 10: Environment Variable Reference.

results matching ""

    No results matching ""