You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: align README, AGENTS, CONTRIBUTING, and Pages entrypoints
Keep install commands on the GitHub raw installer across index and llms,
document open/mcp/completion and project metadata in README, refresh AGENTS
layout and release/tag notes, and match CONTRIBUTING to CHANGELOG [Unreleased]
plus docs-preview and automation cross-links.
go run ./cmd/gendocs -check # docs/commands.md drift check
70
+
make docs-preview # optional: local Jekyll site + /md preview (requires Ruby/Jekyll)
69
71
```
70
72
73
+
Documentation work:
74
+
75
+
- Run `make docs-commands` after command-tree changes; CI uses `go run ./cmd/gendocs -check`.
76
+
- For GitHub Pages content, use `make docs-preview` (see `scripts/preview-pages-site.sh`). Published docs resolve `@@CLI_DOCS_*@@` tokens via `scripts/prepare-pages-site.py` and `docs/site.env` as documented in `docs/automation.md`.
77
+
71
78
Install `golangci-lint` (matches the CI version):
72
79
73
80
```bash
@@ -132,9 +139,11 @@ change; prefer adding a new code and deprecating the old one over a rename.
132
139
133
140
- Fill in the [pull request template](.github/pull_request_template.md).
134
141
- Make sure `make test && make lint` pass locally.
135
-
- Include changelog entries in the `## Unreleased` section of `CHANGELOG.md`
142
+
- Include changelog entries under the `## [Unreleased]` section of `CHANGELOG.md`
136
143
for user-facing changes (new commands, behavior changes, breaking changes,
137
-
CLI exit code changes, error code additions).
144
+
CLI exit code changes, error code additions). When cutting a release, move
145
+
those bullets into a dated `## [x.y.z] - YYYY-MM-DD` section per the note at
146
+
the top of `CHANGELOG.md`.
138
147
- For UI/UX-affecting changes (pretty output, prompts, progress events,
139
148
errors), include before/after copy-paste samples in the PR description.
- Full command reference (auto-generated): [docs/commands.md](docs/commands.md)
@@ -79,6 +80,9 @@ The command model is intentionally layered:
79
80
-`config` for local CLI defaults
80
81
-`telemetry` for telemetry preferences
81
82
-`upgrade` / `update` for package-manager-specific upgrade guidance
83
+
-`open` to open the Console, published CLI docs (human or `/md/` Markdown), or product docs in a browser
84
+
-`mcp` to run the CLI as a local MCP server (`agora mcp serve`) for agent integrations
85
+
-`completion` for shell completion scripts (standard Cobra completion)
82
86
83
87
Discover the full command tree:
84
88
@@ -125,6 +129,14 @@ Reads and updates local CLI defaults such as output mode, log level, and browser
125
129
126
130
Reads and updates telemetry preferences. `DO_NOT_TRACK=1` disables telemetry at runtime.
127
131
132
+
### `open`
133
+
134
+
Opens curated URLs: Console (`--target console`), human CLI docs on GitHub Pages (`docs`), raw Markdown tree for agents (`docs-md`), and Agora product docs (`product-docs`). Use `--no-browser` to print the resolved URL.
135
+
136
+
### `mcp`
137
+
138
+
Runs the CLI as an MCP stdio server so MCP-capable clients can call Agora workflows as tools. Authenticate with `agora login` on the host first; OAuth is not exposed through MCP.
139
+
128
140
### `version`
129
141
130
142
Prints build metadata. Release binaries include version, commit, and build date.
@@ -177,7 +189,7 @@ agora --help --all
177
189
178
190
`quickstart env write` is different from `project env write`, but both keep dotenv files limited to runtime credentials.
179
191
180
-
-`project env write` writes only `AGORA_APP_ID` and `AGORA_APP_CERTIFICATE`
192
+
-`project env write` writes only App ID and App Certificate keys for the detected or `--template`-selected layout (for example `AGORA_*` for standard Node, `NEXT_PUBLIC_*` / `NEXT_*` for Next.js, or `APP_ID` / `APP_CERTIFICATE` for Python and Go). See [docs/automation.md](docs/automation.md) for the full matrix and JSON fields.
181
193
-`quickstart env write` understands the quickstart type and writes only the App ID and App Certificate variable names the cloned repo expects
182
194
- existing `.env` and `.env.local` files are preserved; the CLI appends missing credentials, updates existing credential keys, and comments out duplicate or stale Agora credential aliases for the selected runtime
183
195
@@ -207,13 +219,15 @@ The `.agora/project.json` file is created or updated by:
0 commit comments