From 8c24a7daf371ee15115f6a1328bef1a323b86d0e Mon Sep 17 00:00:00 2001 From: Shantur Rathore Date: Sun, 15 Feb 2026 15:29:06 +0000 Subject: [PATCH] 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 |