> For the complete documentation index, see [llms.txt](https://tinyhumans.gitbook.io/opencompany/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://tinyhumans.gitbook.io/opencompany/for-developers/cli.md). # CLI reference The opencompany binary and its subcommands. The `opencompany` binary is the entrypoint for running and inspecting companies. Invoke it with `cargo run --bin opencompany -- ` from a checkout, or as `opencompany ` from an installed build. ```sh opencompany [options] ``` ## `serve` Run the Axum HTTP host. ```sh opencompany serve --company companies/marketing_agency ``` | Flag | Purpose | | ------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--bind ` | Address to bind. Falls back to `OPENCOMPANY_BIND`, then to `config.toml`'s `bind`, then to `127.0.0.1:8080` — see [bind precedence](/opencompany/for-developers/configuration.md#bind-precedence). | | `--company ` | A company to load at boot — a manifest file or a directory containing one. **Repeatable** for multi-company hosting. | | `--home ` | OpenCompany home holding company bundles (`/companies/`). Falls back to `OPENCOMPANY_DATA_DIR`, then to `$HOME/.opencompany`. | | `--openhuman-root ` | Records that an OpenHuman checkout is configured. Reporting only: `/spec` surfaces it as `openhuman_configured` (a boolean, never the path), and nothing else reads it — it does not choose a checkout to run. To launch one, see [`open-human`](#open-human), which takes its own `--root`. | ## `check` Validate a company manifest and print its effective configuration in plain language. ```sh opencompany check companies/marketing_agency ``` Takes a manifest file or a directory containing `company.toml` / `agents.toml` (defaults to the current directory). ## `doctor` Report the effective runtime configuration, which layer set each value, and what's missing per optional capability. ```sh opencompany doctor --company companies/marketing_agency opencompany doctor --json ``` ## `spec` Print a JSON runtime specification. Accepts `--openhuman-root `, which is reported as `openhuman_configured` — a boolean, never the path — and is not used to run anything. ## `issue-password` Issue a sign-in password for an address a company already admits, from the host — the recovery path when a deployment cannot mail a sign-in link ([issue #1718](https://github.com/tinyhumansai/opencompany/issues/1718)). ```sh opencompany issue-password --company --email ada@example.com ``` The password is read from **stdin** unless passed with `--password`, so it never appears in argv, shell history, or `ps`. Only the trailing newline is stripped; a password may legitimately end in a space. | Flag | Purpose | | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `--company ` | The company id as `serve` registers it. In shared-database mode a bare id is namespaced to the current `OPENCOMPANY_TENANT_ID`; the namespaced `--` form is also accepted, and an id carrying a different tenant's prefix is refused. | | `--email
` | The address to issue for. It must already be a standing admin — a manifest `[users].admins` entry or the injected `OPENCOMPANY_ADMIN_EMAIL` — because the command makes a grant usable; it does not create one. | | `--password ` | The password. Omit to read it from stdin. | | `--no-change-required` | Do not require a replacement on first sign-in. The default requires one, matching an admin-issued temporary password. | | `--home ` | Data root, resolved the same way `serve` resolves it. | It requires the effective email auth mode (`OPENCOMPANY_AUTH_MODE` → `config.toml` → the manifest's `[users] mode`); a `wallet` or `none` company is refused. Committing revokes the user's existing sessions and pending login codes first, then flags the password for replacement — the same semantics as the admin temporary-password route ([users spec](https://github.com/tinyhumansai/opencompany/tree/main/docs/spec/runtime/users.md)). On the filesystem store it holds the same data-root lock as `serve`, so it fails cleanly if a server is running on that root. ## `export` / `import` Move a company's full state (through the storage ports) between homes. ```sh opencompany export --out ./backup opencompany import ./backup ``` `export` excludes `secrets/` and `keys/` unless `--include-secrets` is passed. With `--features export` the output is a single `.tar`; otherwise an unpacked bundle directory. Both accept `--home `, and both fall back to `OPENCOMPANY_DATA_DIR` the same way `serve` does. ## Where state lives Every subcommand that touches company bundles resolves one root, highest precedence first: 1. `--home ` — an explicit flag outranks both entries below. 2. `OPENCOMPANY_DATA_DIR` — the instance data root. Set it to run two hosts side by side; without isolation they share one company store and each one's teammates and desks show up in the other. 3. `$HOME/.opencompany` — the default when neither is set. Bundles hang off `/companies/` in all three cases. Installs created before the default dropped a redundant `companies` leaf are nested one level deeper; `serve`, `export`, and `import` move them up on first launch and print what moved. A same-named company already at the destination is skipped with both paths named, never merged. `OPENCOMPANY_HOME` is not supported. It never was, so setting it used to do nothing silently; `serve`, `export`, and `import` now abort and point at `OPENCOMPANY_DATA_DIR`. The check runs before `--home`, so passing the flag does not silence it. ## `open-human` Launch a sibling OpenHuman checkout through cargo. ```sh opencompany open-human --dry-run -- status ``` | Flag | Purpose | | ------------------------ | ---------------------------------------------------- | | `--root ` | OpenHuman checkout path. Default `vendor/openhuman`. | | `--mode ` | Launch target. Default `core`. | | `--dry-run` | Print the cargo command without executing it. | | `-- ` | Arguments passed through to the OpenHuman binary. |