codeharbor 0.1.23 → 0.1.24
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +4 -0
- package/dist/cli.js +46 -0
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -200,6 +200,8 @@ PLAYWRIGHT_USE_SYSTEM_CHROME=false npm run test:e2e
|
|
|
200
200
|
|
|
201
201
|
- `REQUIREMENTS.md`: current baseline + next-stage requirements
|
|
202
202
|
- `TASK_LIST.md`: implementation task breakdown and status
|
|
203
|
+
- `docs/USER_MANUAL_ZH.md`: Chinese user manual (installation, configuration, verification)
|
|
204
|
+
- `docs/COMPLETE_CONFIGURATION_GUIDE.md`: end-to-end setup flow + full feature-to-config mapping
|
|
203
205
|
- `docs/CONFIG_UI_DESIGN.md`: configuration UI MVP design
|
|
204
206
|
- `docs/CONFIG_CATALOG.md`: consolidated configuration matrix (required/runtime/UI/effective timing)
|
|
205
207
|
- `docs/ADMIN_STANDALONE_DEPLOY.md`: standalone admin deployment and Cloudflare Tunnel exposure guide
|
|
@@ -249,6 +251,7 @@ node dist/cli.js start
|
|
|
249
251
|
Use this layered reference to avoid mixing boot-only and runtime tuning items:
|
|
250
252
|
|
|
251
253
|
- [`docs/CONFIG_CATALOG.md`](docs/CONFIG_CATALOG.md)
|
|
254
|
+
- [`docs/COMPLETE_CONFIGURATION_GUIDE.md`](docs/COMPLETE_CONFIGURATION_GUIDE.md)
|
|
252
255
|
|
|
253
256
|
It documents:
|
|
254
257
|
|
|
@@ -256,6 +259,7 @@ It documents:
|
|
|
256
259
|
- which keys can be edited in Admin UI
|
|
257
260
|
- whether changes are immediate or restart-scoped
|
|
258
261
|
- recommended profiles for local/internal/public deployment
|
|
262
|
+
- a complete setup sequence from install to production operations
|
|
259
263
|
|
|
260
264
|
## Commands
|
|
261
265
|
|
package/dist/cli.js
CHANGED
|
@@ -7978,6 +7978,25 @@ var runtimeHome = null;
|
|
|
7978
7978
|
var cliVersion = resolveCliVersion();
|
|
7979
7979
|
var program = new import_commander.Command();
|
|
7980
7980
|
program.name("codeharbor").description("Instant-messaging bridge for Codex CLI sessions").version(cliVersion);
|
|
7981
|
+
program.addHelpText(
|
|
7982
|
+
"after",
|
|
7983
|
+
[
|
|
7984
|
+
"",
|
|
7985
|
+
"Prerequisites:",
|
|
7986
|
+
" - codex CLI installed and authenticated (run: codex login)",
|
|
7987
|
+
" - Matrix bot credentials in .env: MATRIX_HOMESERVER, MATRIX_USER_ID, MATRIX_ACCESS_TOKEN",
|
|
7988
|
+
"",
|
|
7989
|
+
"Runtime:",
|
|
7990
|
+
" - default CODEHARBOR_HOME: ~/.codeharbor (legacy /opt/codeharbor/.env is auto-detected)",
|
|
7991
|
+
" - running without subcommand defaults to: codeharbor start",
|
|
7992
|
+
"",
|
|
7993
|
+
"Common commands:",
|
|
7994
|
+
" - codeharbor init",
|
|
7995
|
+
" - codeharbor doctor",
|
|
7996
|
+
" - codeharbor service install --with-admin",
|
|
7997
|
+
" - codeharbor admin serve --host 127.0.0.1 --port 8787"
|
|
7998
|
+
].join("\n")
|
|
7999
|
+
);
|
|
7981
8000
|
program.command("init").description("Create or update .env via guided prompts").option("-f, --force", "overwrite existing .env without confirmation").action(async (options) => {
|
|
7982
8001
|
const home = ensureRuntimeHomeOrExit();
|
|
7983
8002
|
await runInitCommand({ force: options.force ?? false, cwd: home });
|
|
@@ -8014,6 +8033,33 @@ program.command("doctor").description("Check codex and matrix connectivity").act
|
|
|
8014
8033
|
var admin = program.command("admin").description("Admin utilities");
|
|
8015
8034
|
var configCommand = program.command("config").description("Config snapshot utilities");
|
|
8016
8035
|
var serviceCommand = program.command("service").description("Systemd service management");
|
|
8036
|
+
admin.addHelpText(
|
|
8037
|
+
"after",
|
|
8038
|
+
[
|
|
8039
|
+
"",
|
|
8040
|
+
"Notes:",
|
|
8041
|
+
" - For non-loopback host binding, set ADMIN_TOKEN or ADMIN_TOKENS_JSON.",
|
|
8042
|
+
" - Admin UI routes: /settings/global, /settings/rooms, /health, /audit."
|
|
8043
|
+
].join("\n")
|
|
8044
|
+
);
|
|
8045
|
+
configCommand.addHelpText(
|
|
8046
|
+
"after",
|
|
8047
|
+
[
|
|
8048
|
+
"",
|
|
8049
|
+
"Examples:",
|
|
8050
|
+
" - codeharbor config export -o backup.json",
|
|
8051
|
+
" - codeharbor config import backup.json --dry-run"
|
|
8052
|
+
].join("\n")
|
|
8053
|
+
);
|
|
8054
|
+
serviceCommand.addHelpText(
|
|
8055
|
+
"after",
|
|
8056
|
+
[
|
|
8057
|
+
"",
|
|
8058
|
+
"Notes:",
|
|
8059
|
+
" - Service subcommands auto-elevate with sudo when required.",
|
|
8060
|
+
" - Use --with-admin to manage both main and admin services together."
|
|
8061
|
+
].join("\n")
|
|
8062
|
+
);
|
|
8017
8063
|
admin.command("serve").description("Start admin config API server").option("--host <host>", "override admin bind host").option("--port <port>", "override admin bind port").option(
|
|
8018
8064
|
"--allow-insecure-no-token",
|
|
8019
8065
|
"allow serving admin API without ADMIN_TOKEN on non-loopback host (not recommended)"
|