docs: reorganize server and dev release docs
This commit is contained in:
19
README.md
19
README.md
@@ -45,7 +45,7 @@ npx @neuralnomads/codenomad --launch
|
|||||||
```
|
```
|
||||||
|
|
||||||
Full server/CLI documentation (flags + env vars, TLS, auth, remote access):
|
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:
|
To see all available options:
|
||||||
|
|
||||||
@@ -53,26 +53,13 @@ To see all available options:
|
|||||||
npx @neuralnomads/codenomad --help
|
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:
|
### 🧪 Dev Releases
|
||||||
|
Bleeding-edge builds are published as GitHub pre-releases and are generated automatically from the `dev` branch.
|
||||||
```bash
|
|
||||||
npm install @neuralnomads/codenomad
|
|
||||||
npx codenomad --launch
|
|
||||||
```
|
|
||||||
|
|
||||||
For dev version
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
npx @neuralnomads/codenomad-dev --launch
|
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
|
## Highlights
|
||||||
|
|
||||||
- **Multi-Instance**: Juggle several OpenCode sessions side-by-side with tabs.
|
- **Multi-Instance**: Juggle several OpenCode sessions side-by-side with tabs.
|
||||||
|
|||||||
@@ -90,7 +90,13 @@ You can configure the server using flags or environment variables:
|
|||||||
| `--ui-auto-update <enabled>` | `CLI_UI_AUTO_UPDATE` | Enable remote UI updates (true|false) |
|
| `--ui-auto-update <enabled>` | `CLI_UI_AUTO_UPDATE` | Enable remote UI updates (true|false) |
|
||||||
| `--ui-manifest-url <url>` | `CLI_UI_MANIFEST_URL` | Remote UI manifest URL |
|
| `--ui-manifest-url <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:
|
These environment variables control how CodeNomad checks for dev updates:
|
||||||
|
|
||||||
| Env Variable | Description |
|
| Env Variable | Description |
|
||||||
|
|||||||
Reference in New Issue
Block a user