Skip to content

Self-improving AI Employees for everyone

chore(cli): update help text and install hints

trohitg6d8a62fc5b95
diff --git a/cli/cli.py b/cli/cli.py
index a7303832..f43867e6 100644
--- a/cli/cli.py
+++ b/cli/cli.py
@@ -3,7 +3,7 @@
Every verb is registered here as a thin stub that lazy-imports its
implementation on dispatch. Running ``company clean`` (the recovery
verb) only triggers the import of ``cli.commands.clean`` -- not
-``dev`` / ``start`` / temporal specs / daemon verbs / docs / version.
+``dev`` / ``start`` / daemon verbs / docs / version.
Pattern lifted from gemini-cli's ``gemini.tsx`` + vercel's ``vc.js``
(fast-path ``--version`` and ``--help`` before any heavy import) and
@@ -44,7 +44,7 @@ def _root() -> None:
@app.command(
"start",
- help="Start all services in production mode (static client + uvicorn + temporal).",
+ help="Start in production mode: uvicorn serves API + WebSocket + built SPA on one port (the backend starts Temporal itself when enabled).",
)
def _start() -> None:
from cli.commands.start import start_command
@@ -54,7 +54,7 @@ def _start() -> None:
@app.command(
"dev",
- help="Start all services in dev mode (Vite HMR + uvicorn + temporal).",
+ help="Start in dev mode: Vite HMR + uvicorn (the backend starts Temporal itself when enabled).",
)
def _dev(
daemon: bool = typer.Option(
@@ -192,7 +192,7 @@ def _deploy_up(
owner_password: str | None = typer.Option(
None, "--owner-password", help="Login password (>=8 chars). Generated + printed once if omitted."
),
- source: str = typer.Option("local", "--source", help="Install source: local (npm pack) or release (npm registry)."),
+ source: str = typer.Option("local", "--source", help="Install source: local (bun pm pack of this checkout) or release (npm registry)."),
version: str = typer.Option("latest", "--version", help="opencompany version when --source release."),
machine_type: str = typer.Option("e2-standard-2", "--machine-type", help="VM size."),
port: int | None = typer.Option(None, "--port", help="Public port the app binds + the firewall opens (default: PYTHON_BACKEND_PORT from .env.template)."),
diff --git a/cli/commands/build.py b/cli/commands/build.py
index f0bc6e03..71c1a647 100644
--- a/cli/commands/build.py
+++ b/cli/commands/build.py
@@ -2,7 +2,7 @@
Checks toolchain (node, bun, python, uv), then runs the 6-step
build: ``.env`` bootstrap -> ``bun install`` -> client build ->
-JS executor sidecar bundle (bun build) -> ``uv sync`` -> compile Python bytecode
+JS executor sidecar bundle (bun build) -> ``uv sync --extra docs`` -> compile Python bytecode
-> pooch-fetch Temporal binary.
Layers ``.env.dev`` (when present in the checkout) BEFORE running
@@ -156,8 +156,8 @@ def build_command() -> None:
# fresh checkout.
#
# Safe for global installs: ``.env.dev`` is committed to git for
- # repo-clone contributors but is NOT in the npm ``files`` list, so
- # ``npm install -g @zeenie-ai/opencompany`` doesn't ship it. Without
+ # repo-clone contributors but is NOT in the root package.json ``files``
+ # list, so ``bun add -g @zeenie-ai/opencompany`` doesn't ship it. Without
# ``.env.dev`` on disk, :func:`load_dev_overrides` is a no-op and
# the build falls through to ``.env.template`` defaults
# (``DATA_DIR=~/.opencompany``) — identical to today's behaviour and
diff --git a/cli/config.py b/cli/config.py
index 8dae0c34..da0bc32d 100644
--- a/cli/config.py
+++ b/cli/config.py
@@ -5,8 +5,10 @@ Stdlib-only env-var loader. Three env files, lowest precedence first:
1. ``.env.template`` — canonical production defaults. Ships with every
install. ``DATA_DIR=~/.opencompany`` (user home) is the daemon
behaviour: ``company start`` / ``company daemon`` use these.
- 2. ``.env`` — user overrides (created by ``scripts/postinstall.js`` on
- ``npm install -g @zeenie-ai/opencompany``). Gitignored.
+ 2. ``.env`` — user overrides (created from the template by
+ ``scripts/install.js``, which ``company provision`` runs after
+ ``bun add -g @zeenie-ai/opencompany``, or by ``company build`` in a
+ checkout). Gitignored.
3. ``.env.dev`` — dev-mode overrides. Loaded ONLY by ``company dev``
via :func:`load_dev_overrides`. Pins ``DATA_DIR=.opencompany`` so
per-checkout dev state lives at ``<repo>/.opencompany/`` instead of
@@ -55,7 +57,7 @@ def _require(env: dict[str, str], key: str) -> str:
if raw is None:
raise KeyError(
f"{key} missing from .env / .env.template -- "
- "reinstall (``npm install -g @zeenie-ai/opencompany``) or restore the template."
+ "reinstall (``bun add -g @zeenie-ai/opencompany``) or restore the template."
)
return raw
@@ -92,8 +94,8 @@ class Config:
# ``temporal_ui_port`` are bound by the same ``temporal server
# start-dev`` process, so killing one kills both — listing both
# only matters when cleaning up stale orphans on either port.
- # Plugin-owned daemons (WhatsApp's edgymeow, the Node.js executor
- # sidecar) are NOT listed: the backend supervises them (tree-kill
+ # Plugin-owned daemons (WhatsApp's edgymeow, the JS executor
+ # sidecar on bun) are NOT listed: the backend supervises them (tree-kill
# on shutdown), and the CLI carries no plugin knowledge. A
# crashed-backend orphan surfaces as a bind error on the plugin's
# next start, which the plugin reports.
@@ -144,7 +146,7 @@ def load_config(root: Path | None = None) -> Config:
if not template.exists():
raise FileNotFoundError(
f".env.template not found at {template}. "
- "Reinstall (``npm install -g @zeenie-ai/opencompany``) or restore the template "
+ "Reinstall (``bun add -g @zeenie-ai/opencompany``) or restore the template "
"from the source tree."
)