From 682937e945651aad4e0fb3b88869e8f7f7586f9c Mon Sep 17 00:00:00 2001 From: Shantur Rathore Date: Sun, 15 Feb 2026 15:21:09 +0000 Subject: [PATCH 1/2] docs(server): improve CLI flag/env var docs Make server usage easier to discover from the root README, add local install/run instructions, and document additional CLI flags/env vars for UI and logging. --- README.md | 16 ++++++++++++++++ packages/server/README.md | 30 ++++++++++++++++++++++++++++++ 2 files changed, 46 insertions(+) diff --git a/README.md b/README.md index 9276ad4c..b0d2709f 100644 --- a/README.md +++ b/README.md @@ -44,6 +44,22 @@ Run CodeNomad as a local server and access it via your web browser. Perfect for npx @neuralnomads/codenomad --launch ``` +Full server/CLI documentation (flags + env vars, TLS, auth, remote access): +`packages/server/README.md` + +To see all available options: + +```bash +npx @neuralnomads/codenomad --help +``` + +If you prefer not to run it as a one-off `npx @neuralnomads/codenomad`, you can install it and run the local binary: + +```bash +npm install @neuralnomads/codenomad +npx codenomad --launch +``` + For dev version ```bash diff --git a/packages/server/README.md b/packages/server/README.md index 2eff0a24..05d42742 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -31,6 +31,12 @@ You can run CodeNomad directly without installing it: npx @neuralnomads/codenomad --launch ``` +To list all CLI options: + +```sh +npx @neuralnomads/codenomad --help +``` + On startup, CodeNomad prints two URLs: - `Local Connection URL : ...` (used by desktop shells) @@ -44,6 +50,16 @@ npm install -g @neuralnomads/codenomad codenomad --launch ``` +### Install Locally (per-project) +If you prefer to install CodeNomad into a project and run the local binary: + +```sh +npm install @neuralnomads/codenomad +npx codenomad --launch +``` + +(`npx codenomad ...` will use `./node_modules/.bin/codenomad` when present.) + ### Common Flags You can configure the server using flags or environment variables: @@ -63,10 +79,24 @@ You can configure the server using flags or environment variables: | `--config ` | `CLI_CONFIG` | Config file location | | `--launch` | `CLI_LAUNCH` | Open the UI in a Chromium-based browser | | `--log-level ` | `CLI_LOG_LEVEL` | Logging level (trace, debug, info, warn, error) | +| `--log-destination ` | `CLI_LOG_DESTINATION` | Log destination file (defaults to stdout) | | `--username ` | `CODENOMAD_SERVER_USERNAME` | Username for CodeNomad's internal auth (default `codenomad`) | | `--password ` | `CODENOMAD_SERVER_PASSWORD` | Password for CodeNomad's internal auth | | `--generate-token` | `CODENOMAD_GENERATE_TOKEN` | Emit a one-time local bootstrap token for desktop flows | | `--dangerously-skip-auth` | `CODENOMAD_SKIP_AUTH` | Disable CodeNomad's internal auth (use only behind a trusted perimeter) | +| `--ui-dir ` | `CLI_UI_DIR` | Directory containing the built UI bundle | +| `--ui-dev-server ` | `CLI_UI_DEV_SERVER` | Proxy UI requests to a running dev server (requires `--https=false --http=true`) | +| `--ui-no-update` | `CLI_UI_NO_UPDATE` | Disable remote UI updates | +| `--ui-auto-update ` | `CLI_UI_AUTO_UPDATE` | Enable remote UI updates (true|false) | +| `--ui-manifest-url ` | `CLI_UI_MANIFEST_URL` | Remote UI manifest URL | + +### Update Checks (Advanced) +These environment variables control how CodeNomad checks for dev updates: + +| Env Variable | Description | +|-------------|-------------| +| `CODENOMAD_UPDATE_CHANNEL` | Update channel (use `dev` to enable dev build update checks) | +| `CODENOMAD_GITHUB_REPO` | GitHub repo used for dev release checks (default `NeuralNomadsAI/CodeNomad`) | ### HTTP vs HTTPS From 8c24a7daf371ee15115f6a1328bef1a323b86d0e Mon Sep 17 00:00:00 2001 From: Shantur Rathore Date: Sun, 15 Feb 2026 15:29:06 +0000 Subject: [PATCH 2/2] docs: reorganize server and dev release docs --- README.md | 19 +++---------------- packages/server/README.md | 8 +++++++- 2 files changed, 10 insertions(+), 17 deletions(-) diff --git a/README.md b/README.md index b0d2709f..eae634f3 100644 --- a/README.md +++ b/README.md @@ -45,7 +45,7 @@ npx @neuralnomads/codenomad --launch ``` Full server/CLI documentation (flags + env vars, TLS, auth, remote access): -`packages/server/README.md` +- [packages/server/README.md](packages/server/README.md) To see all available options: @@ -53,26 +53,13 @@ To see all available options: npx @neuralnomads/codenomad --help ``` -If you prefer not to run it as a one-off `npx @neuralnomads/codenomad`, you can install it and run the local binary: - -```bash -npm install @neuralnomads/codenomad -npx codenomad --launch -``` - -For dev version +### 🧪 Dev Releases +Bleeding-edge builds are published as GitHub pre-releases and are generated automatically from the `dev` branch. ```bash npx @neuralnomads/codenomad-dev --launch ``` -Dev builds are published as GitHub pre-releases: -https://github.com/shantur/CodeNomad/releases - -Dev releases are bleeding-edge builds, generated automatically every time a new commit is pushed to the `dev` branch. - -This command starts the server and opens the web client in your default browser. - ## Highlights - **Multi-Instance**: Juggle several OpenCode sessions side-by-side with tabs. diff --git a/packages/server/README.md b/packages/server/README.md index 05d42742..cb798eb1 100644 --- a/packages/server/README.md +++ b/packages/server/README.md @@ -90,7 +90,13 @@ You can configure the server using flags or environment variables: | `--ui-auto-update ` | `CLI_UI_AUTO_UPDATE` | Enable remote UI updates (true|false) | | `--ui-manifest-url ` | `CLI_UI_MANIFEST_URL` | Remote UI manifest URL | -### Update Checks (Advanced) +### Dev Releases (Advanced) +If you want the latest bleeding-edge builds (published as GitHub pre-releases), use the dev package: + +```sh +npx @neuralnomads/codenomad-dev --launch +``` + These environment variables control how CodeNomad checks for dev updates: | Env Variable | Description |