@rse/ase 1.0.7 → 2.0.0
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/dst/ase-agent-definition-api.d.ts +184 -0
- package/dst/ase-agent-definition-api.js +6 -0
- package/dst/ase-agent-definition-builtin/condenser.js +42 -0
- package/dst/ase-agent-definition-builtin/editor.js +45 -0
- package/dst/ase-agent-definition-builtin/estimator.js +98 -0
- package/dst/ase-agent-definition-builtin/implementer.js +121 -0
- package/dst/ase-agent-definition-builtin/integrator.js +56 -0
- package/dst/ase-agent-definition-builtin/qualifier.js +61 -0
- package/dst/ase-agent-definition-builtin/rebooter.js +41 -0
- package/dst/ase-agent-definition-builtin/researcher.js +77 -0
- package/dst/ase-agent-definition-core.js +827 -0
- package/dst/ase-agent-fleet.js +772 -0
- package/dst/ase-agent-process.js +232 -0
- package/dst/ase-agent-relay-client.js +509 -0
- package/dst/ase-agent-relay-core.js +213 -0
- package/dst/ase-agent-relay-server-bind.js +242 -0
- package/dst/ase-agent-relay-server-cli.js +50 -0
- package/dst/ase-agent-runtime-claim.js +189 -0
- package/dst/ase-agent-runtime-engine.js +1100 -0
- package/dst/ase-agent-runtime-exec.js +275 -0
- package/dst/ase-agent-runtime-phase.js +581 -0
- package/dst/ase-agent-runtime-request.js +272 -0
- package/dst/ase-agent-runtime-tool.js +207 -0
- package/dst/ase-agent-runtime.js +1316 -0
- package/dst/ase-agent.js +65 -0
- package/dst/ase-artifact.js +6 -5
- package/dst/ase-config-core.js +465 -0
- package/dst/ase-config-schema.js +351 -0
- package/dst/ase-config-scope.js +172 -0
- package/dst/ase-config.js +25 -585
- package/dst/ase-hook.js +228 -111
- package/dst/ase-lib-daemon-cli.js +130 -0
- package/dst/ase-lib-hash.js +20 -0
- package/dst/{ase-log.js → ase-lib-log.js} +40 -7
- package/dst/ase-lib-server-bind.js +115 -0
- package/dst/ase-lib-server-cli.js +474 -0
- package/dst/{ase-table.js → ase-lib-table.js} +1 -1
- package/dst/{ase-version.js → ase-lib-version.js} +3 -0
- package/dst/ase-man.js +96 -0
- package/dst/ase-mcp.js +166 -13
- package/dst/{ase-getopt.js → ase-service-getopt.js} +82 -80
- package/dst/{ase-markdown.js → ase-service-markdown.js} +18 -11
- package/dst/ase-service-otel.js +1246 -0
- package/dst/{ase-skills.js → ase-service-skills.js} +29 -64
- package/dst/ase-service-state.js +101 -0
- package/dst/ase-service.js +251 -76
- package/dst/ase-setup-common.js +141 -0
- package/dst/ase-setup-mcp.js +359 -0
- package/dst/ase-setup-settings.js +837 -0
- package/dst/ase-setup.js +113 -869
- package/dst/ase-spec.js +31 -19
- package/dst/ase-statusline.js +108 -43
- package/dst/ase-task-board-core.js +739 -0
- package/dst/ase-task-board-filter.js +127 -0
- package/dst/ase-task-board-flow.js +237 -0
- package/dst/ase-task-board-graph.js +497 -0
- package/dst/ase-task-board-stats.js +263 -0
- package/dst/ase-task-board-tui-control.js +775 -0
- package/dst/ase-task-board-tui-model.js +1008 -0
- package/dst/ase-task-board-tui-popup.js +626 -0
- package/dst/ase-task-board-tui-style.js +106 -0
- package/dst/ase-task-board-tui-view.js +847 -0
- package/dst/ase-task-board-tui.js +189 -0
- package/dst/ase-task-board-web-client.css +1 -0
- package/dst/ase-task-board-web-client.html +20 -0
- package/dst/ase-task-board-web-client.js +81 -0
- package/dst/ase-task-board-web-server.js +823 -0
- package/dst/ase-task-board.js +134 -0
- package/dst/ase-task-format.js +757 -0
- package/dst/ase-task-request.js +208 -0
- package/dst/ase-task-store-client.js +495 -0
- package/dst/ase-task-store-core.js +804 -0
- package/dst/ase-task-store-issues.js +237 -0
- package/dst/ase-task-store-plugin-api.js +6 -0
- package/dst/ase-task-store-plugin-ase.js +484 -0
- package/dst/ase-task-store-plugin-delegate.js +137 -0
- package/dst/ase-task-store-plugin-gitea.js +666 -0
- package/dst/ase-task-store-plugin-github.js +696 -0
- package/dst/ase-task-store-plugin-gitlab.js +668 -0
- package/dst/ase-task-store-server-bind.js +538 -0
- package/dst/ase-task-store-server-cli.js +154 -0
- package/dst/ase-task.js +1335 -357
- package/dst/{ase-compat.js → ase-util-compat.js} +2 -2
- package/dst/{ase-diagram.js → ase-util-diagram.js} +107 -32
- package/dst/{ase-meta.js → ase-util-meta.js} +2 -2
- package/dst/{ase-metric.js → ase-util-metric.js} +2 -2
- package/dst/{ase-mint.js → ase-util-mint.js} +19 -12
- package/dst/{ase-worktree.js → ase-util-worktree.js} +30 -19
- package/dst/ase-util.js +20 -0
- package/dst/ase.js +108 -32
- package/dst/man/ase-agent-adhoc.1 +515 -0
- package/dst/man/ase-agent-condenser.1 +193 -0
- package/dst/man/ase-agent-editor.1 +212 -0
- package/dst/man/ase-agent-estimator.1 +214 -0
- package/dst/man/ase-agent-fleet.1 +185 -0
- package/dst/man/ase-agent-implementer.1 +233 -0
- package/dst/man/ase-agent-integrator.1 +213 -0
- package/dst/man/ase-agent-qualifier.1 +214 -0
- package/dst/man/ase-agent-rebooter.1 +193 -0
- package/dst/man/ase-agent-relay.1 +128 -0
- package/dst/man/ase-agent-researcher.1 +217 -0
- package/dst/man/ase-agent.1 +264 -0
- package/dst/man/ase-artifact-list.1 +38 -0
- package/dst/man/ase-artifact-name.1 +39 -0
- package/dst/man/ase-artifact.1 +56 -0
- package/dst/man/ase-config-delete.1 +45 -0
- package/dst/man/ase-config-edit.1 +48 -0
- package/dst/man/ase-config-get.1 +46 -0
- package/dst/man/ase-config-init.1 +60 -0
- package/dst/man/ase-config-list.1 +42 -0
- package/dst/man/ase-config-set.1 +52 -0
- package/dst/man/ase-config.1 +225 -0
- package/dst/man/ase-hook-permission-request.1 +36 -0
- package/dst/man/ase-hook-pre-tool-use.1 +59 -0
- package/dst/man/ase-hook-session-end.1 +47 -0
- package/dst/man/ase-hook-session-persona.1 +37 -0
- package/dst/man/ase-hook-session-start.1 +81 -0
- package/dst/man/ase-hook-stop.1 +34 -0
- package/dst/man/ase-hook-user-prompt-submit.1 +34 -0
- package/dst/man/ase-hook.1 +51 -0
- package/dst/man/ase-man.1 +67 -0
- package/dst/man/ase-mcp.1 +61 -0
- package/dst/man/ase-service-log.1 +43 -0
- package/dst/man/ase-service-send.1 +47 -0
- package/dst/man/ase-service-start.1 +54 -0
- package/dst/man/ase-service-status.1 +46 -0
- package/dst/man/ase-service-stop.1 +37 -0
- package/dst/man/ase-service.1 +85 -0
- package/dst/man/ase-setup-disable.1 +44 -0
- package/dst/man/ase-setup-enable.1 +45 -0
- package/dst/man/ase-setup-install.1 +73 -0
- package/dst/man/ase-setup-mcp.1 +124 -0
- package/dst/man/ase-setup-status.1 +60 -0
- package/dst/man/ase-setup-statusline.1 +92 -0
- package/dst/man/ase-setup-telemetry.1 +92 -0
- package/dst/man/ase-setup-uninstall.1 +59 -0
- package/dst/man/ase-setup-update.1 +64 -0
- package/dst/man/ase-setup.1 +93 -0
- package/dst/man/ase-spec-export.1 +62 -0
- package/dst/man/ase-spec-lint.1 +40 -0
- package/dst/man/ase-spec-preview.1 +40 -0
- package/dst/man/ase-spec.1 +46 -0
- package/dst/man/ase-statusline.1 +189 -0
- package/dst/man/ase-task-assign.1 +71 -0
- package/dst/man/ase-task-board.1 +384 -0
- package/dst/man/ase-task-delete.1 +35 -0
- package/dst/man/ase-task-edit.1 +46 -0
- package/dst/man/ase-task-idscheme.1 +65 -0
- package/dst/man/ase-task-lifecycle.1 +57 -0
- package/dst/man/ase-task-list.1 +47 -0
- package/dst/man/ase-task-load.1 +36 -0
- package/dst/man/ase-task-newid.1 +61 -0
- package/dst/man/ase-task-purge.1 +37 -0
- package/dst/man/ase-task-rename.1 +44 -0
- package/dst/man/ase-task-request.1 +61 -0
- package/dst/man/ase-task-save.1 +48 -0
- package/dst/man/ase-task-status.1 +55 -0
- package/dst/man/ase-task-store.1 +194 -0
- package/dst/man/ase-task-view.1 +40 -0
- package/dst/man/ase-task.1 +160 -0
- package/dst/man/ase-util-compat.1 +25 -0
- package/dst/man/ase-util-diagram.1 +76 -0
- package/dst/man/ase-util-meta.1 +45 -0
- package/dst/man/ase-util-metric.1 +54 -0
- package/dst/man/ase-util-mint.1 +59 -0
- package/dst/man/ase-util-worktree.1 +72 -0
- package/dst/man/ase-util.1 +50 -0
- package/dst/man/ase.1 +124 -0
- package/package.json +79 -21
- package/plugin/.claude-plugin/plugin.json +1 -1
- package/plugin/.codex-plugin/plugin.json +1 -1
- package/plugin/.github/plugin/plugin.json +1 -1
- package/plugin/agents/ase-meta-diagram.md +12 -8
- package/plugin/agents/ase-repo-review.md +322 -0
- package/plugin/hooks/hooks-codex.json +5 -0
- package/plugin/hooks/hooks-copilot.json +5 -0
- package/plugin/hooks/hooks.json +8 -0
- package/plugin/meta/ase-common-approach.md +117 -0
- package/plugin/meta/ase-common-changeset.md +256 -0
- package/plugin/meta/ase-common-code.md +10 -173
- package/plugin/meta/ase-common-grill.md +317 -0
- package/plugin/meta/ase-common-resolve.md +305 -0
- package/plugin/meta/ase-common-task.md +83 -4
- package/plugin/meta/ase-constitution.md +0 -2
- package/plugin/meta/ase-format-specbook.md +208 -25
- package/plugin/meta/ase-format-specbook.yaml +242 -851
- package/plugin/meta/ase-format-task.md +669 -125
- package/plugin/meta/ase-persona.md +3 -4
- package/plugin/meta/ase-skill.md +9 -0
- package/plugin/mods/ase-mods.ts +409 -0
- package/plugin/mods/claude-code.d.ts +13417 -0
- package/plugin/skills/ase-arch-analyze/SKILL.md +1 -1
- package/plugin/skills/ase-arch-analyze/help.md +2 -2
- package/plugin/skills/ase-code-analyze/SKILL.md +59 -8
- package/plugin/skills/ase-code-analyze/help.md +29 -4
- package/plugin/skills/ase-code-edit/SKILL.md +107 -181
- package/plugin/skills/ase-code-edit/help.md +118 -31
- package/plugin/skills/ase-code-lint/SKILL.md +64 -13
- package/plugin/skills/ase-code-lint/help.md +32 -2
- package/plugin/skills/ase-docs-proofread/SKILL.md +4 -4
- package/plugin/skills/ase-docs-proofread/help.md +1 -1
- package/plugin/skills/ase-docs-refine/SKILL.md +4 -4
- package/plugin/skills/ase-docs-shorten/SKILL.md +4 -4
- package/plugin/skills/ase-help-intent/data.md +2164 -1087
- package/plugin/skills/ase-help-intent/help.md +1 -1
- package/plugin/skills/ase-help-skill/catalog.md +12 -9
- package/plugin/skills/ase-meta-brainstorm/SKILL.md +1 -1
- package/plugin/skills/ase-meta-config/SKILL.md +3 -4
- package/plugin/skills/ase-meta-config/help.md +31 -10
- package/plugin/skills/ase-meta-mint/SKILL.md +5 -5
- package/plugin/skills/ase-meta-mint/help.md +10 -5
- package/plugin/skills/ase-meta-why/help.md +1 -1
- package/plugin/skills/ase-meta-workflow/SKILL.md +7 -7
- package/plugin/skills/ase-meta-workflow/help.md +4 -4
- package/plugin/skills/ase-meta-workflow/sample.md +3 -3
- package/plugin/skills/ase-meta-workflow/workflow.txt +22 -18
- package/plugin/skills/{ase-meta-changelog → ase-repo-changelog}/SKILL.md +4 -3
- package/plugin/skills/{ase-meta-changelog → ase-repo-changelog}/help.md +5 -5
- package/plugin/skills/{ase-meta-commit → ase-repo-commit}/SKILL.md +6 -6
- package/plugin/skills/{ase-meta-commit → ase-repo-commit}/help.md +5 -5
- package/plugin/skills/{ase-meta-diff → ase-repo-diff}/SKILL.md +6 -6
- package/plugin/skills/{ase-meta-diff → ase-repo-diff}/help.md +8 -8
- package/plugin/skills/{ase-code-dissect → ase-repo-dissect}/SKILL.md +19 -19
- package/plugin/skills/{ase-code-dissect → ase-repo-dissect}/help.md +10 -12
- package/plugin/skills/ase-repo-merge/SKILL.md +346 -0
- package/plugin/skills/ase-repo-merge/help.md +107 -0
- package/plugin/skills/ase-repo-resolve/SKILL.md +158 -0
- package/plugin/skills/ase-repo-resolve/help.md +102 -0
- package/plugin/skills/ase-repo-review/SKILL.md +406 -0
- package/plugin/skills/ase-repo-review/help.md +181 -0
- package/plugin/skills/ase-spec-edit/SKILL.md +117 -183
- package/plugin/skills/ase-spec-edit/help.md +107 -26
- package/plugin/skills/ase-sync-reconcile/help.md +1 -1
- package/plugin/skills/ase-task-assign/SKILL.md +111 -0
- package/plugin/skills/ase-task-assign/help.md +119 -0
- package/plugin/skills/ase-task-condense/SKILL.md +21 -21
- package/plugin/skills/ase-task-condense/help.md +12 -10
- package/plugin/skills/ase-task-delete/SKILL.md +1 -1
- package/plugin/skills/ase-task-dissect/SKILL.md +71 -48
- package/plugin/skills/ase-task-dissect/help.md +10 -9
- package/plugin/skills/ase-task-edit/SKILL.md +379 -94
- package/plugin/skills/ase-task-edit/help.md +95 -22
- package/plugin/skills/ase-task-estimate/SKILL.md +492 -0
- package/plugin/skills/ase-task-estimate/help.md +158 -0
- package/plugin/skills/ase-task-grill/SKILL.md +246 -138
- package/plugin/skills/ase-task-grill/help.md +129 -26
- package/plugin/skills/ase-task-id/SKILL.md +8 -1
- package/plugin/skills/ase-task-id/help.md +6 -3
- package/plugin/skills/ase-task-implement/SKILL.md +535 -145
- package/plugin/skills/ase-task-implement/help.md +138 -47
- package/plugin/skills/ase-task-integrate/SKILL.md +549 -0
- package/plugin/skills/ase-task-integrate/help.md +187 -0
- package/plugin/skills/ase-task-list/SKILL.md +55 -23
- package/plugin/skills/ase-task-list/help.md +45 -21
- package/plugin/skills/ase-task-reboot/SKILL.md +84 -43
- package/plugin/skills/ase-task-reboot/help.md +28 -8
- package/plugin/skills/ase-task-rename/SKILL.md +10 -2
- package/plugin/skills/ase-task-research/SKILL.md +386 -0
- package/plugin/skills/ase-task-research/help.md +102 -0
- package/plugin/skills/ase-task-status/SKILL.md +137 -0
- package/plugin/skills/ase-task-status/help.md +80 -0
- package/plugin/skills/ase-task-view/SKILL.md +49 -24
- package/plugin/skills/ase-task-view/help.md +19 -9
- package/plugin/agents/ase-meta-review.md +0 -187
- package/plugin/skills/ase-code-craft/SKILL.md +0 -264
- package/plugin/skills/ase-code-craft/help.md +0 -122
- package/plugin/skills/ase-code-refactor/SKILL.md +0 -232
- package/plugin/skills/ase-code-refactor/help.md +0 -109
- package/plugin/skills/ase-code-resolve/SKILL.md +0 -289
- package/plugin/skills/ase-code-resolve/help.md +0 -116
- package/plugin/skills/ase-meta-review/SKILL.md +0 -210
- package/plugin/skills/ase-meta-review/help.md +0 -96
- package/plugin/skills/ase-task-preflight/SKILL.md +0 -166
- package/plugin/skills/ase-task-preflight/help.md +0 -82
- /package/dst/{ase-ignore.js → ase-lib-ignore.js} +0 -0
- /package/dst/{ase-stdio.js → ase-lib-stdio.js} +0 -0
- /package/dst/{ase-kv.js → ase-service-kv.js} +0 -0
- /package/dst/{ase-sleep.js → ase-service-sleep.js} +0 -0
- /package/dst/{ase-timestamp.js → ase-service-timestamp.js} +0 -0
|
@@ -0,0 +1,92 @@
|
|
|
1
|
+
.TH "ASE-SETUP-TELEMETRY" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-setup-telemetry\fR - Activate or Deactivate the ASE Telemetry Export
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase setup telemetry\fR \[lB]\fB-h\fR|\fB--help\fR\[rB]
|
|
7
|
+
.P
|
|
8
|
+
\fBase setup telemetry activate\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]
|
|
9
|
+
.P
|
|
10
|
+
\fBase setup telemetry deactivate\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]
|
|
11
|
+
.SH "DESCRIPTION"
|
|
12
|
+
.P
|
|
13
|
+
\fBase setup telemetry\fR activates or deactivates the \fIOpenTelemetry\fR (OTLP/HTTP) export of the agent tool towards the per-user \fIASE\fR OTLP ingress \fBhttp://127.0.0.1:\fR\fIport\fR (with \fIport\fR from the configuration \fBtelemetry.service.port\fR, default \fB44318\fR), which feeds the AI usage accounting of the task assignments (see \fBase-task-assign\fR(1)). Without a sub-command, the usage information is shown and the command exits with status \fB1\fR.
|
|
14
|
+
.P
|
|
15
|
+
The export is always user-level, as the agent tools ignore these settings on repository level, so a single ingress serves the sessions of all projects: every running \fBase service\fR tries to hold its port, and the holder routes the records by their session to the service of the owning project. Hence, there is no \fB--scope\fR option.
|
|
16
|
+
.P
|
|
17
|
+
Telemetry configured by the user for other receivers is never touched: it is preserved with a warning (and the command still exits with status \fB0\fR), and reported as \fBforeign\fR by \fBase setup status\fR.
|
|
18
|
+
.SH "COMMANDS"
|
|
19
|
+
.RS 0
|
|
20
|
+
.IP \(bu 4
|
|
21
|
+
\fBase setup telemetry activate\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Configure the telemetry export of the agent tool. As the AI usage accounting is opt-in, this requires the configuration \fBtelemetry.enabled\fR to be \fBtrue\fR (e.g., via \fBase config set
|
|
22
|
+
telemetry.enabled true\fR on scope \fBuser\fR or \fBproject\fR), else the command fails with an error. A missing bearer token \fBtelemetry.service.token\fR is generated (48 hexadecimal digits) and persisted on scope \fBuser\fR. Per agent tool:
|
|
23
|
+
.RS 4
|
|
24
|
+
.IP \(bu 4
|
|
25
|
+
\fBclaude\fR: The variables \fBCLAUDE_CODE_ENABLE_TELEMETRY=1\fR, \fBOTEL_LOGS_EXPORTER=otlp\fR, \fBOTEL_EXPORTER_OTLP_PROTOCOL=http/json\fR, \fBOTEL_EXPORTER_OTLP_ENDPOINT=\fR\fIurl\fR, \fBOTEL_EXPORTER_OTLP_HEADERS=Authorization=Bearer \fR\fItoken\fR, and \fBOTEL_LOGS_EXPORT_INTERVAL=5000\fR are added to (resp. updated in) the \fBenv\fR object of \fB~/.claude/settings.json\fR.
|
|
26
|
+
.sp
|
|
27
|
+
If any of these variables is already set there, but points neither to the URL nor carries the token of the \fIASE\fR ingress, the configuration is foreign and preserved; a non-object \fBenv\fR is preserved, too.
|
|
28
|
+
.IP \(bu 4
|
|
29
|
+
\fBcodex\fR: A marked block (between the lines \fB# BEGIN ASE telemetry
|
|
30
|
+
(generated)\fR and \fB# END ASE telemetry (generated)\fR) with an \fB\[lB]otel\[rB]\fR table, exporting via \fBotlp-http\fR with protocol \fBjson\fR to \fIurl\fR\fB/v1/logs\fR with the \fBauthorization\fR header \fBBearer\fR \fItoken\fR, is added to (resp. replaced in) \fB$CODEX_HOME/config.toml\fR (default: \fB~/.codex/config.toml\fR). An \fB\[lB]otel\[rB]\fR table outside of the block is foreign and preserved.
|
|
31
|
+
.IP \(bu 4
|
|
32
|
+
\fBcopilot\fR: As \fIGitHub Copilot CLI\fR is configurable via environment variables only, a marked block with a shell function \fBcopilot\fR is added to (resp. replaced in) the shell profile of the login shell of \fB$SHELL\fR (\fB$ZDOTDIR/.zshrc\fR, default \fB~/.zshrc\fR, for \fBzsh\fR, and \fB~/.bashrc\fR for \fBbash\fR), which passes the variables \fBCOPILOT_OTEL_ENABLED=true\fR, \fBCOPILOT_OTEL_EXPORTER_TYPE=otlp-http\fR, \fBOTEL_EXPORTER_OTLP_ENDPOINT=\fR\fIurl\fR, \fBOTEL_EXPORTER_OTLP_PROTOCOL=http/json\fR, and \fBOTEL_EXPORTER_OTLP_HEADERS=Authorization=Bearer \fR\fItoken\fR to the \fBcopilot\fR command only, instead of exporting them to every other program. A new shell session is required for it to take effect.
|
|
33
|
+
.sp
|
|
34
|
+
For any other shell, the command fails with an error showing the shell function to define manually. An \fB$OTEL_EXPORTER_OTLP_ENDPOINT\fR of the environment other than the \fIASE\fR ingress URL, and an assignment of \fBCOPILOT_OTEL_ENABLED\fR or \fBOTEL_EXPORTER_OTLP_ENDPOINT\fR in the profile outside of the block, are foreign and preserved.
|
|
35
|
+
.RE 0
|
|
36
|
+
.IP \(bu 4
|
|
37
|
+
\fBase setup telemetry deactivate\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Remove the telemetry export configured by \fBase setup telemetry
|
|
38
|
+
activate\fR again, preserving any foreign telemetry configuration. It does not require \fBtelemetry.enabled\fR.
|
|
39
|
+
.sp
|
|
40
|
+
Per agent tool: for \fBclaude\fR, the above variables are removed from the \fBenv\fR of \fB~/.claude/settings.json\fR (and the \fBenv\fR itself, if it became empty); for \fBcodex\fR, the marked block is removed from \fB$CODEX_HOME/config.toml\fR; and for \fBcopilot\fR, the marked block is removed from all candidate shell profiles (\fB~/.zshrc\fR, \fB~/.bashrc\fR, and the profile of the login shell). A missing file or configuration is skipped with an informational message.
|
|
41
|
+
.RE 0
|
|
42
|
+
.SH "OPTIONS"
|
|
43
|
+
.RS 0
|
|
44
|
+
.IP \(bu 4
|
|
45
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
46
|
+
.IP \(bu 4
|
|
47
|
+
\[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Select the target agent tool: \fBclaude\fR, \fBcopilot\fR, or \fBcodex\fR (default: \fB$ASE_TOOL\fR, else \fBclaude\fR).
|
|
48
|
+
.RE 0
|
|
49
|
+
.SH "ENVIRONMENT"
|
|
50
|
+
.RS 0
|
|
51
|
+
.IP \(bu 4
|
|
52
|
+
\fBASE_TOOL\fR: The default of \fB--tool\fR.
|
|
53
|
+
.IP \(bu 4
|
|
54
|
+
\fBCODEX_HOME\fR: The configuration directory of \fIOpenAI Codex CLI\fR (default: \fB~/.codex\fR).
|
|
55
|
+
.IP \(bu 4
|
|
56
|
+
\fBSHELL\fR, \fBZDOTDIR\fR: The login shell, determining the shell profile for \fB--tool copilot\fR, and the configuration directory of \fBzsh\fR.
|
|
57
|
+
.IP \(bu 4
|
|
58
|
+
\fBOTEL_EXPORTER_OTLP_ENDPOINT\fR: An existing OTLP endpoint for \fB--tool copilot\fR, which, if not the \fIASE\fR ingress, is considered a foreign telemetry configuration.
|
|
59
|
+
.RE 0
|
|
60
|
+
.SH "FILES"
|
|
61
|
+
.RS 0
|
|
62
|
+
.IP \(bu 4
|
|
63
|
+
\fB~/.claude/settings.json\fR: The user-level settings file of \fIAnthropic Claude Code CLI\fR.
|
|
64
|
+
.IP \(bu 4
|
|
65
|
+
\fB$CODEX_HOME/config.toml\fR (default: \fB~/.codex/config.toml\fR): The configuration file of \fIOpenAI Codex CLI\fR.
|
|
66
|
+
.IP \(bu 4
|
|
67
|
+
\fB~/.zshrc\fR, \fB~/.bashrc\fR: The shell profiles receiving the \fBcopilot\fR shell function.
|
|
68
|
+
.RE 0
|
|
69
|
+
.SH "EXIT STATUS"
|
|
70
|
+
.P
|
|
71
|
+
\fB0\fR on success (including a preserved foreign configuration), \fB1\fR on any error (e.g., a disabled AI usage accounting on \fBactivate\fR, an unsupported shell for \fB--tool copilot\fR, an unterminated marked block, and when invoked without a sub-command).
|
|
72
|
+
.SH "EXAMPLES"
|
|
73
|
+
.P
|
|
74
|
+
.RS 2
|
|
75
|
+
.nf
|
|
76
|
+
# enable the AI usage accounting and activate the export of Claude Code
|
|
77
|
+
$ ase config --scope user set telemetry.enabled true
|
|
78
|
+
$ ase setup telemetry activate
|
|
79
|
+
|
|
80
|
+
# activate the export of OpenAI Codex CLI
|
|
81
|
+
$ ase setup telemetry activate --tool codex
|
|
82
|
+
|
|
83
|
+
# deactivate the export of GitHub Copilot CLI
|
|
84
|
+
$ ase setup telemetry deactivate --tool copilot
|
|
85
|
+
.fi
|
|
86
|
+
.RE
|
|
87
|
+
.SH "SEE ALSO"
|
|
88
|
+
.P
|
|
89
|
+
\fBase\fR(1), \fBase-setup\fR(1), \fBase-setup-status\fR(1), \fBase-config\fR(1), \fBase-service\fR(1), \fBase-task-assign\fR(1).
|
|
90
|
+
.SH "AUTHOR"
|
|
91
|
+
.P
|
|
92
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,59 @@
|
|
|
1
|
+
.TH "ASE-SETUP-UNINSTALL" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-setup-uninstall\fR - Uninstall the ASE Plugin and Tool
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase setup uninstall\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB] \[lB]\fB-d\fR|\fB--dev\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase setup uninstall\fR uninstalls the \fIASE\fR plugin from the agent tool selected by \fB--tool\fR and the \fIASE\fR tool itself. It requires \fBnpm\fR(1) and the CLI of the agent tool to be found in \fB$PATH\fR. The steps are:
|
|
10
|
+
.RS 0
|
|
11
|
+
.IP 1. 4
|
|
12
|
+
A potentially running \fBase service\fR of the current project is stopped (on a best-effort basis).
|
|
13
|
+
.IP 2. 4
|
|
14
|
+
For \fB--tool claude\fR, the selection of the output style \fBase:ase-terse\fR is removed from the \fBsettings.json\fR of the installation scope, while a foreign \fBoutputStyle\fR is preserved with a warning.
|
|
15
|
+
.IP 3. 4
|
|
16
|
+
The plugin \fBase@ase\fR is uninstalled (\fB<cli> plugin uninstall
|
|
17
|
+
ase@ase\fR, resp. \fBcodex plugin remove ase@ase\fR) and the plugin marketplace \fBase\fR is removed (\fB<cli> plugin marketplace remove
|
|
18
|
+
ase\fR), where an already absent plugin or marketplace is skipped.
|
|
19
|
+
.IP 4. 4
|
|
20
|
+
Unless in development mode (\fB--dev\fR), the tool is uninstalled via \fBnpm uninstall -g @rse/ase\fR (prefixed with \fBsudo\fR(8) if the global \fBnpm\fR installation root is not writable by the current user and \fBsudo\fR is available).
|
|
21
|
+
.RE 0
|
|
22
|
+
.SH "OPTIONS"
|
|
23
|
+
.RS 0
|
|
24
|
+
.IP \(bu 4
|
|
25
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
26
|
+
.IP \(bu 4
|
|
27
|
+
\[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Select the target agent tool: \fBclaude\fR, \fBcopilot\fR, or \fBcodex\fR (default: \fB$ASE_TOOL\fR, else \fBclaude\fR).
|
|
28
|
+
.IP \(bu 4
|
|
29
|
+
\[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB]: Select the plugin installation scope: \fBuser\fR, \fBproject\fR, or \fBlocal\fR. The default is auto-detected from the existing installation: the scopes \fBlocal\fR, \fBproject\fR, and \fBuser\fR are probed in this order, and the first one whose settings file registers the plugin \fBase@ase\fR under \fBenabledPlugins\fR is taken, falling back to \fBuser\fR. Only supported for \fB--tool claude\fR; a non-\fBuser\fR scope for \fBcopilot\fR or \fBcodex\fR fails with an error.
|
|
30
|
+
.IP \(bu 4
|
|
31
|
+
\[lB]\fB-d\fR|\fB--dev\fR\[rB]: Development mode: uninstall the plugin only, but keep the \fIASE\fR tool, as it is the local working copy (default: \fB$ASE_SETUP_DEV\fR).
|
|
32
|
+
.RE 0
|
|
33
|
+
.SH "ENVIRONMENT"
|
|
34
|
+
.RS 0
|
|
35
|
+
.IP \(bu 4
|
|
36
|
+
\fBASE_TOOL\fR: The default of \fB--tool\fR.
|
|
37
|
+
.IP \(bu 4
|
|
38
|
+
\fBASE_SETUP_DEV\fR: The default of \fB--dev\fR: any non-empty value other than \fB0\fR and \fBfalse\fR (case-insensitive) enables it.
|
|
39
|
+
.RE 0
|
|
40
|
+
.SH "EXIT STATUS"
|
|
41
|
+
.P
|
|
42
|
+
\fB0\fR on success, \fB1\fR on any error.
|
|
43
|
+
.SH "EXAMPLES"
|
|
44
|
+
.P
|
|
45
|
+
.RS 2
|
|
46
|
+
.nf
|
|
47
|
+
# uninstall ASE from Anthropic Claude Code CLI
|
|
48
|
+
$ ase setup uninstall
|
|
49
|
+
|
|
50
|
+
# uninstall the plugin from GitHub Copilot CLI
|
|
51
|
+
$ ase setup uninstall --tool copilot
|
|
52
|
+
.fi
|
|
53
|
+
.RE
|
|
54
|
+
.SH "SEE ALSO"
|
|
55
|
+
.P
|
|
56
|
+
\fBase\fR(1), \fBase-setup\fR(1), \fBase-setup-install\fR(1), \fBase-setup-disable\fR(1), \fBnpm\fR(1).
|
|
57
|
+
.SH "AUTHOR"
|
|
58
|
+
.P
|
|
59
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,64 @@
|
|
|
1
|
+
.TH "ASE-SETUP-UPDATE" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-setup-update\fR - Update the ASE Tool and Plugin
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase setup update\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB] \[lB]\fB-f\fR|\fB--force\fR\[rB] \[lB]\fB-d\fR|\fB--dev\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase setup update\fR updates the \fIASE\fR tool and the \fIASE\fR plugin of the agent tool selected by \fB--tool\fR to their latest versions. It requires \fBnpm\fR(1) and the CLI of the agent tool to be found in \fB$PATH\fR. First, a potentially running \fBase service\fR of the current project is stopped (on a best-effort basis), as it would otherwise keep running the old code.
|
|
10
|
+
.P
|
|
11
|
+
In the regular mode, the current version of the tool is compared with the latest version of \fB@rse/ase\fR known from the NPM registry (as determined by a cached background check, refreshed at most once per hour). If both are equal, the command reports that \fIASE\fR is already at the latest version and exits without any further action (unless \fB--force\fR is given).
|
|
12
|
+
.P
|
|
13
|
+
Otherwise, the tool is updated via \fBnpm update -g @rse/ase\fR (prefixed with \fBsudo\fR(8) if the global \fBnpm\fR installation root is not writable by the current user and \fBsudo\fR is available), the plugin marketplace snapshot is refreshed (\fB<cli> plugin marketplace update ase\fR, resp. \fBcodex plugin marketplace upgrade ase\fR), and the plugin is updated (\fB<cli> plugin update ase@ase\fR, resp. removed and re-added for \fIOpenAI Codex CLI\fR, which has no plugin update command).
|
|
14
|
+
.P
|
|
15
|
+
In the development mode (\fB--dev\fR), the local \fIASE\fR working copy is re-built instead (\fBnpm install\fR and \fBnpm start build\fR in its \fBtool/\fR directory), and the plugin is re-installed (uninstalled and installed again), as the local plugin files are already current, but carry no version change in the plugin manifest.
|
|
16
|
+
.P
|
|
17
|
+
Like \fBase setup install\fR, for \fB--tool claude\fR, the output style \fBase:ase-terse\fR is finally selected in the \fBsettings.json\fR of the installation scope, unless a foreign \fBoutputStyle\fR is already selected there, which is preserved with a warning.
|
|
18
|
+
.SH "OPTIONS"
|
|
19
|
+
.RS 0
|
|
20
|
+
.IP \(bu 4
|
|
21
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
22
|
+
.IP \(bu 4
|
|
23
|
+
\[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Select the target agent tool: \fBclaude\fR, \fBcopilot\fR, or \fBcodex\fR (default: \fB$ASE_TOOL\fR, else \fBclaude\fR).
|
|
24
|
+
.IP \(bu 4
|
|
25
|
+
\[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB]: Select the plugin installation scope: \fBuser\fR, \fBproject\fR, or \fBlocal\fR. The default is auto-detected from the existing installation: the scopes \fBlocal\fR, \fBproject\fR, and \fBuser\fR are probed in this order (strongest first), and the first one whose settings file registers the plugin \fBase@ase\fR under \fBenabledPlugins\fR (enabled or disabled) is taken, falling back to \fBuser\fR when no installation is found.
|
|
26
|
+
.sp
|
|
27
|
+
For tools other than \fBclaude\fR, the scope is always \fBuser\fR, and an explicitly given non-\fBuser\fR scope fails with an error.
|
|
28
|
+
.IP \(bu 4
|
|
29
|
+
\[lB]\fB-f\fR|\fB--force\fR\[rB]: Always perform the update, even if the tool is already at the latest version (default: off). Without effect in combination with \fB--dev\fR, which always re-builds.
|
|
30
|
+
.IP \(bu 4
|
|
31
|
+
\[lB]\fB-d\fR|\fB--dev\fR\[rB]: Development mode: re-build the local \fIASE\fR working copy (\fB$ASE_SETUP_DEV_BASEDIR\fR, else the parent directory of the \fB@rse/ase\fR package directory) and re-install the plugin from it, instead of updating from the NPM registry (default: \fB$ASE_SETUP_DEV\fR).
|
|
32
|
+
.RE 0
|
|
33
|
+
.SH "ENVIRONMENT"
|
|
34
|
+
.RS 0
|
|
35
|
+
.IP \(bu 4
|
|
36
|
+
\fBASE_TOOL\fR: The default of \fB--tool\fR.
|
|
37
|
+
.IP \(bu 4
|
|
38
|
+
\fBASE_SETUP_DEV\fR: The default of \fB--dev\fR: any non-empty value other than \fB0\fR and \fBfalse\fR (case-insensitive) enables it.
|
|
39
|
+
.IP \(bu 4
|
|
40
|
+
\fBASE_SETUP_DEV_BASEDIR\fR: The local \fIASE\fR working copy used with \fB--dev\fR.
|
|
41
|
+
.RE 0
|
|
42
|
+
.SH "EXIT STATUS"
|
|
43
|
+
.P
|
|
44
|
+
\fB0\fR on success (including an already current version), \fB1\fR on any error.
|
|
45
|
+
.SH "EXAMPLES"
|
|
46
|
+
.P
|
|
47
|
+
.RS 2
|
|
48
|
+
.nf
|
|
49
|
+
# update ASE for Anthropic Claude Code CLI
|
|
50
|
+
$ ase setup update
|
|
51
|
+
|
|
52
|
+
# force the update for OpenAI Codex CLI
|
|
53
|
+
$ ase setup update --tool codex --force
|
|
54
|
+
|
|
55
|
+
# re-build and re-install from the local working copy
|
|
56
|
+
$ ase setup update --dev
|
|
57
|
+
.fi
|
|
58
|
+
.RE
|
|
59
|
+
.SH "SEE ALSO"
|
|
60
|
+
.P
|
|
61
|
+
\fBase\fR(1), \fBase-setup\fR(1), \fBase-setup-install\fR(1), \fBase-setup-uninstall\fR(1), \fBase-service\fR(1), \fBnpm\fR(1).
|
|
62
|
+
.SH "AUTHOR"
|
|
63
|
+
.P
|
|
64
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,93 @@
|
|
|
1
|
+
.TH "ASE-SETUP" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-setup\fR - Install, Update, and Uninstall the ASE Tool and Plugin
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase setup\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \fIcommand\fR \[lB]\fIoptions\fR \[lB]...\[rB]\[rB] \[lB]\fIargs\fR \[lB]...\[rB]\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase setup\fR is the entry point group for installing, updating, uninstalling, enabling, disabling, and reporting the \fIASE\fR tool and its companion agent tool plugin, and for activating or deactivating the pre-defined foreign MCP servers, the \fIASE\fR statusline, and the \fIASE\fR telemetry export towards the AI usage accounting. Without a \fIcommand\fR, the usage information is shown and the command exits with status \fB1\fR.
|
|
10
|
+
.P
|
|
11
|
+
The target agent tool is either \fIAnthropic Claude Code CLI\fR (\fBclaude\fR), \fIGitHub Copilot CLI\fR (\fBcopilot\fR), or \fIOpenAI Codex CLI\fR (\fBcodex\fR). All operations are performed through the plugin and MCP commands of the respective agent tool CLI (e.g., \fBclaude plugin
|
|
12
|
+
install\fR), which hence has to be found in \fB$PATH\fR, and through direct edits of its settings files (for the output style, the statusline, and the telemetry). Every sub-process command is logged (with API keys masked) and its output is shown only on failure.
|
|
13
|
+
.SH "OPTIONS"
|
|
14
|
+
.RS 0
|
|
15
|
+
.IP \(bu 4
|
|
16
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information of the command group and exit.
|
|
17
|
+
.RE 0
|
|
18
|
+
.P
|
|
19
|
+
The following options are shared by most sub-commands (see their individual manual pages for the exact applicability):
|
|
20
|
+
.RS 0
|
|
21
|
+
.IP \(bu 4
|
|
22
|
+
\[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Select the target agent tool: \fBclaude\fR (\fIAnthropic Claude Code CLI\fR), \fBcopilot\fR (\fIGitHub Copilot CLI\fR), or \fBcodex\fR (\fIOpenAI Codex CLI\fR). The default is the value of the environment variable \fBASE_TOOL\fR, if set and non-empty, else \fBclaude\fR. An invalid value is rejected with an error. Accepted by all sub-commands except \fBase
|
|
23
|
+
setup mcp list\fR.
|
|
24
|
+
.IP \(bu 4
|
|
25
|
+
\[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB]: Select the installation scope of the plugin, MCP server, or statusline registration: \fBuser\fR (registered globally for the current user), \fBproject\fR (registered in the project and meant to be shared via version control), or \fBlocal\fR (registered in the project, but kept out of version control).
|
|
26
|
+
.sp
|
|
27
|
+
Only supported for \fB--tool claude\fR (and, for the statusline, a \fBuser\fR scope for \fB--tool copilot\fR); a non-\fBuser\fR scope for any other tool fails with an error, as those agent tools have no scope concept. Not accepted by \fBase setup status\fR (which reports all scopes at once) and \fBase setup telemetry\fR (which is always user-level).
|
|
28
|
+
.RE 0
|
|
29
|
+
.SH "COMMANDS"
|
|
30
|
+
.RS 0
|
|
31
|
+
.IP \(bu 4
|
|
32
|
+
\fBase setup install\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB] \[lB]\fB-d\fR|\fB--dev\fR\[rB]: Install the \fIASE\fR plugin into the agent tool. See \fBase-setup-install\fR(1).
|
|
33
|
+
.IP \(bu 4
|
|
34
|
+
\fBase setup update\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB] \[lB]\fB-f\fR|\fB--force\fR\[rB] \[lB]\fB-d\fR|\fB--dev\fR\[rB]: Update the \fIASE\fR tool and the \fIASE\fR plugin to their latest versions. See \fBase-setup-update\fR(1).
|
|
35
|
+
.IP \(bu 4
|
|
36
|
+
\fBase setup uninstall\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB] \[lB]\fB-d\fR|\fB--dev\fR\[rB]: Uninstall the \fIASE\fR plugin and the \fIASE\fR tool. See \fBase-setup-uninstall\fR(1).
|
|
37
|
+
.IP \(bu 4
|
|
38
|
+
\fBase setup enable\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB]: Enable the already installed \fIASE\fR plugin. See \fBase-setup-enable\fR(1).
|
|
39
|
+
.IP \(bu 4
|
|
40
|
+
\fBase setup disable\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB] \[lB]\fB-s\fR|\fB--scope\fR \fIscope\fR\[rB]: Disable the \fIASE\fR plugin without uninstalling it. See \fBase-setup-disable\fR(1).
|
|
41
|
+
.IP \(bu 4
|
|
42
|
+
\fBase setup status\fR \[lB]\fB-t\fR|\fB--tool\fR \fItool\fR\[rB]: Report the plugin, MCP server, output style, statusline, and telemetry registrations of all scopes. See \fBase-setup-status\fR(1).
|
|
43
|
+
.IP \(bu 4
|
|
44
|
+
\fBase setup mcp\fR \fBlist\fR|\fBactivate\fR|\fBdeactivate\fR \[lB]...\[rB]: List, activate, or deactivate the pre-defined foreign MCP servers. See \fBase-setup-mcp\fR(1).
|
|
45
|
+
.IP \(bu 4
|
|
46
|
+
\fBase setup statusline\fR \fBactivate\fR|\fBdeactivate\fR \[lB]...\[rB]: Activate or deactivate the \fIASE\fR statusline. See \fBase-setup-statusline\fR(1).
|
|
47
|
+
.IP \(bu 4
|
|
48
|
+
\fBase setup telemetry\fR \fBactivate\fR|\fBdeactivate\fR \[lB]...\[rB]: Activate or deactivate the \fIOpenTelemetry\fR export of the agent tool towards the \fIASE\fR OTLP ingress. See \fBase-setup-telemetry\fR(1).
|
|
49
|
+
.RE 0
|
|
50
|
+
.SH "ENVIRONMENT"
|
|
51
|
+
.RS 0
|
|
52
|
+
.IP \(bu 4
|
|
53
|
+
\fBASE_TOOL\fR: The default of the \fB--tool\fR option (default: \fBclaude\fR).
|
|
54
|
+
.IP \(bu 4
|
|
55
|
+
\fBASE_SETUP_DEV\fR: The default of the \fB--dev\fR option of \fBase setup install\fR, \fBase setup
|
|
56
|
+
update\fR, and \fBase setup uninstall\fR: any non-empty value other than \fB0\fR and \fBfalse\fR (case-insensitive) enables it.
|
|
57
|
+
.IP \(bu 4
|
|
58
|
+
\fBASE_SETUP_DEV_BASEDIR\fR: The base directory of the local \fIASE\fR working copy used with \fB--dev\fR (default: the parent directory of the installed \fB@rse/ase\fR package directory).
|
|
59
|
+
.IP \(bu 4
|
|
60
|
+
\fBASE_MCP_KEY_\fR\fIKEY\fR: The API keys of the pre-defined MCP servers (see \fBase-setup-mcp\fR(1)).
|
|
61
|
+
.RE 0
|
|
62
|
+
.SH "FILES"
|
|
63
|
+
.RS 0
|
|
64
|
+
.IP \(bu 4
|
|
65
|
+
\fB~/.claude/settings.json\fR, \fB.claude/settings.json\fR, \fB.claude/settings.local.json\fR: The settings files of \fIAnthropic Claude Code CLI\fR of the scopes \fBuser\fR, \fBproject\fR, and \fBlocal\fR (the latter two relative to the current working directory).
|
|
66
|
+
.IP \(bu 4
|
|
67
|
+
\fB$COPILOT_HOME/settings.json\fR (default: \fB~/.copilot/settings.json\fR): The single per-user settings file of \fIGitHub Copilot CLI\fR.
|
|
68
|
+
.IP \(bu 4
|
|
69
|
+
\fB$CODEX_HOME/config.toml\fR (default: \fB~/.codex/config.toml\fR): The per-user configuration file of \fIOpenAI Codex CLI\fR.
|
|
70
|
+
.RE 0
|
|
71
|
+
.SH "EXIT STATUS"
|
|
72
|
+
.P
|
|
73
|
+
\fB0\fR on success, \fB1\fR on any error, and \fB1\fR when invoked without a \fIcommand\fR.
|
|
74
|
+
.SH "EXAMPLES"
|
|
75
|
+
.P
|
|
76
|
+
.RS 2
|
|
77
|
+
.nf
|
|
78
|
+
# install ASE for Anthropic Claude Code CLI globally
|
|
79
|
+
$ ase setup install
|
|
80
|
+
|
|
81
|
+
# install ASE for OpenAI Codex CLI
|
|
82
|
+
$ ase setup install --tool codex
|
|
83
|
+
|
|
84
|
+
# report all ASE registrations
|
|
85
|
+
$ ase setup status
|
|
86
|
+
.fi
|
|
87
|
+
.RE
|
|
88
|
+
.SH "SEE ALSO"
|
|
89
|
+
.P
|
|
90
|
+
\fBase\fR(1), \fBase-setup-install\fR(1), \fBase-setup-update\fR(1), \fBase-setup-uninstall\fR(1), \fBase-setup-enable\fR(1), \fBase-setup-disable\fR(1), \fBase-setup-status\fR(1), \fBase-setup-mcp\fR(1), \fBase-setup-statusline\fR(1), \fBase-setup-telemetry\fR(1), \fBclaude\fR(1), \fBcopilot\fR(1), \fBcodex\fR(1), \fBnpm\fR(1).
|
|
91
|
+
.SH "AUTHOR"
|
|
92
|
+
.P
|
|
93
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,62 @@
|
|
|
1
|
+
.TH "ASE-SPEC-EXPORT" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-spec-export\fR - Export the Project Specification
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase spec export\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-o\fR|\fB--output\fR \[lB]\fIformat\fR\fB:\fR\[rB]\fIfile\fR\[rB] \[lB]...\[rB] \[lB]\fB-w\fR|\fB--watch\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase spec export\fR exports the \fISpecBook\fR-based specification Markdown files below \fBproject.artifact.spec.basedir\fR (see \fBase-spec\fR(1)) into one or more output files. The supported formats are:
|
|
10
|
+
.RS 0
|
|
11
|
+
.IP \(bu 4
|
|
12
|
+
\fBjson\fR, \fBjson5\fR, \fByaml\fR, \fBtoon\fR: The specification object model in the respective serialization.
|
|
13
|
+
.IP \(bu 4
|
|
14
|
+
\fBhtml\fR: A self-contained single HTML document.
|
|
15
|
+
.IP \(bu 4
|
|
16
|
+
\fBpdf\fR: A paginated print document.
|
|
17
|
+
.IP \(bu 4
|
|
18
|
+
\fBmd\fR: A normalized single Markdown document.
|
|
19
|
+
.RE 0
|
|
20
|
+
.P
|
|
21
|
+
The specification is parsed once, and each distinct format is exported once, even if requested for multiple outputs. Each written file is logged at the \fBinfo\fR level. The export fails on any lint diagnostic of \fBerror\fR severity (see \fBase-spec-lint\fR(1)), while warnings are only logged, so a partial or invalid specification is never emitted.
|
|
22
|
+
.P
|
|
23
|
+
The \fBpdf\fR format additionally requires a Chromium-class browser, which neither \fBnpm install -g @rse/ase\fR nor \fBase setup install\fR provides: unless a \fIGoogle Chrome\fR is installed system-wide, fetch the \fIPlaywright\fR Chromium once via \fBnpx playwright install chromium\fR. Without any such browser, the export fails before the specification is even parsed and reports that very command.
|
|
24
|
+
.P
|
|
25
|
+
The MCP tool \fBase_specbook_export\fR provides the same to the skills.
|
|
26
|
+
.SH "OPTIONS"
|
|
27
|
+
.RS 0
|
|
28
|
+
.IP \(bu 4
|
|
29
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
30
|
+
.IP \(bu 4
|
|
31
|
+
\[lB]\fB-o\fR|\fB--output\fR \[lB]\fIformat\fR\fB:\fR\[rB]\fIfile\fR\[rB]: Write the export into \fIfile\fR, or to standard output for \fB-\fR. The option is repeatable, so multiple outputs (of the same or different formats) are written in a single run. The \fIformat\fR is inferred from the filename extension (\fBjson\fR, \fBjson5\fR, \fByaml\fR or \fByml\fR, \fBtoon\fR, \fBhtml\fR or \fBhtm\fR, \fBpdf\fR, and \fBmd\fR or \fBmarkdown\fR, case-insensitive) unless explicitly given as a prefix of at least two characters (out of the same names), where a plain \fB-\fR defaults to \fBjson\fR.
|
|
32
|
+
.sp
|
|
33
|
+
The log is written to standard error (see \fBase\fR(1)), so it never mixes into the export on standard output. An unknown format prefix and a not inferable format are errors. A relative \fIfile\fR is relative to the current working directory. Default: the HTML rendering into \fBindex.html\fR inside the specification base directory (e.g., \fBdocs/specbook/index.html\fR).
|
|
34
|
+
.IP \(bu 4
|
|
35
|
+
\[lB]\fB-w\fR|\fB--watch\fR\[rB]: Do not terminate after the initial export, but keep the outputs in sync by re-exporting on every change of a configuration file, an artifact file, or one of its embedded assets (bursts of changes are coalesced). A transiently failing re-export leaves the watch intact. As a re-export has to land somewhere it can be picked up again, \fB--watch\fR rejects the \fB-\fR standard output. The command then runs until it is interrupted (e.g., via \fBCTRL+C\fR).
|
|
36
|
+
.RE 0
|
|
37
|
+
.SH "EXIT STATUS"
|
|
38
|
+
.P
|
|
39
|
+
Exits with status \fB0\fR on success, and with status \fB1\fR on any lint diagnostic of \fBerror\fR severity, an invalid output specification, a missing browser for \fBpdf\fR, an unwritable output file, or \fB--watch\fR combined with \fB-\fR.
|
|
40
|
+
.SH "EXAMPLES"
|
|
41
|
+
.P
|
|
42
|
+
.RS 2
|
|
43
|
+
.nf
|
|
44
|
+
# export the specification as HTML into its default location
|
|
45
|
+
$ ase spec export
|
|
46
|
+
|
|
47
|
+
# export the specification as PDF and as JSON in a single run
|
|
48
|
+
$ ase spec export -o spec.pdf -o spec.json
|
|
49
|
+
|
|
50
|
+
# export the normalized Markdown to standard output
|
|
51
|
+
$ ase spec export -o md:-
|
|
52
|
+
|
|
53
|
+
# keep an HTML export in sync with the sources
|
|
54
|
+
$ ase spec export -o /tmp/spec.html -w
|
|
55
|
+
.fi
|
|
56
|
+
.RE
|
|
57
|
+
.SH "SEE ALSO"
|
|
58
|
+
.P
|
|
59
|
+
\fBase\fR(1), \fBase-spec\fR(1), \fBase-spec-lint\fR(1), \fBase-spec-preview\fR(1).
|
|
60
|
+
.SH "AUTHOR"
|
|
61
|
+
.P
|
|
62
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
.TH "ASE-SPEC-LINT" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-spec-lint\fR - Lint the Project Specification
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase spec lint\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-v\fR|\fB--verbose\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase spec lint\fR lints the \fISpecBook\fR-based specification Markdown files below \fBproject.artifact.spec.basedir\fR against the \fISpecBook\fR schema configuration \fBproject.artifact.spec.schema\fR (see \fBase-spec\fR(1)).
|
|
10
|
+
.P
|
|
11
|
+
Every diagnostic is printed to standard output as a single line \fIfile\fR\fB:\fR\fIline\fR\fB:\fR\fIcolumn\fR\fB: \fR\fImessage\fR, where \fIfile\fR is relative to the project root (a file outside the project, like the bundled standard schema, is kept as-is), and \fImessage\fR is prefixed with \fBwarning: \fR for a diagnostic of \fBwarning\fR severity. Without any diagnostic, nothing is printed.
|
|
12
|
+
.P
|
|
13
|
+
The MCP tool \fBase_specbook_lint\fR provides the same to the skills.
|
|
14
|
+
.SH "OPTIONS"
|
|
15
|
+
.RS 0
|
|
16
|
+
.IP \(bu 4
|
|
17
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
18
|
+
.IP \(bu 4
|
|
19
|
+
\[lB]\fB-v\fR|\fB--verbose\fR\[rB]: Print each diagnostic as a multi-line message with the affected source snippet (with an \fBERROR\fR resp. \fBWARNING\fR type), colorized if standard output is a terminal. If the source file is unreadable or empty, the single-line message is printed instead.
|
|
20
|
+
.RE 0
|
|
21
|
+
.SH "EXIT STATUS"
|
|
22
|
+
.P
|
|
23
|
+
Exits with status \fB0\fR if there is no diagnostic of \fBerror\fR severity (warnings alone do not fail), and with status \fB1\fR if there is any diagnostic of \fBerror\fR severity or the linting itself failed (e.g., an unreadable schema configuration).
|
|
24
|
+
.SH "EXAMPLES"
|
|
25
|
+
.P
|
|
26
|
+
.RS 2
|
|
27
|
+
.nf
|
|
28
|
+
# lint the specification
|
|
29
|
+
$ ase spec lint
|
|
30
|
+
|
|
31
|
+
# lint the specification, showing the affected source snippets
|
|
32
|
+
$ ase spec lint -v
|
|
33
|
+
.fi
|
|
34
|
+
.RE
|
|
35
|
+
.SH "SEE ALSO"
|
|
36
|
+
.P
|
|
37
|
+
\fBase\fR(1), \fBase-spec\fR(1), \fBase-spec-export\fR(1), \fBase-spec-preview\fR(1).
|
|
38
|
+
.SH "AUTHOR"
|
|
39
|
+
.P
|
|
40
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,40 @@
|
|
|
1
|
+
.TH "ASE-SPEC-PREVIEW" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-spec-preview\fR - Serve a Live Preview of the Project Specification
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase spec preview\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-a\fR|\fB--addr\fR \fIip-addr\fR\[rB] \[lB]\fB-p\fR|\fB--port\fR \fItcp-port\fR\[rB]
|
|
7
|
+
.SH "DESCRIPTION"
|
|
8
|
+
.P
|
|
9
|
+
\fBase spec preview\fR serves the HTML export of the \fISpecBook\fR-based specification Markdown files below \fBproject.artifact.spec.basedir\fR (see \fBase-spec\fR(1)) as a live preview on \fBhttp://\fR\fIip-addr\fR\fB:\fR\fItcp-port\fR\fB/\fR (default: \fBhttp://127.0.0.1:12345/\fR). The export is kept in sync with its sources exactly like under \fBase spec export --watch\fR (see \fBase-spec-export\fR(1)), and every fresh export is pushed into the connected browsers as an in-place document update. Before the first successful export, a placeholder page is served instead.
|
|
10
|
+
.P
|
|
11
|
+
The command does not terminate on its own, but runs until it is interrupted (e.g., via \fBCTRL+C\fR).
|
|
12
|
+
.SH "OPTIONS"
|
|
13
|
+
.RS 0
|
|
14
|
+
.IP \(bu 4
|
|
15
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
16
|
+
.IP \(bu 4
|
|
17
|
+
\[lB]\fB-a\fR|\fB--addr\fR \fIip-addr\fR\[rB]: The IP address to listen on (default: \fB127.0.0.1\fR).
|
|
18
|
+
.IP \(bu 4
|
|
19
|
+
\[lB]\fB-p\fR|\fB--port\fR \fItcp-port\fR\[rB]: The TCP port to listen on, an integer in the range \fB1\fR..\fB65535\fR (default: \fB12345\fR).
|
|
20
|
+
.RE 0
|
|
21
|
+
.SH "EXIT STATUS"
|
|
22
|
+
.P
|
|
23
|
+
Runs until interrupted. Exits with status \fB1\fR on an invalid TCP port or if the server cannot be started.
|
|
24
|
+
.SH "EXAMPLES"
|
|
25
|
+
.P
|
|
26
|
+
.RS 2
|
|
27
|
+
.nf
|
|
28
|
+
# serve the live preview on the default address and port
|
|
29
|
+
$ ase spec preview
|
|
30
|
+
|
|
31
|
+
# serve the live preview on all interfaces on port 8080
|
|
32
|
+
$ ase spec preview -a 0.0.0.0 -p 8080
|
|
33
|
+
.fi
|
|
34
|
+
.RE
|
|
35
|
+
.SH "SEE ALSO"
|
|
36
|
+
.P
|
|
37
|
+
\fBase\fR(1), \fBase-spec\fR(1), \fBase-spec-export\fR(1), \fBase-spec-lint\fR(1).
|
|
38
|
+
.SH "AUTHOR"
|
|
39
|
+
.P
|
|
40
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
.TH "ASE-SPEC" "1" "October 2026" "2.0.0" "Agentic Software Engineering (ASE)"
|
|
2
|
+
.SH "NAME"
|
|
3
|
+
\fBase-spec\fR - Lint, Export, and Preview the Project Specification
|
|
4
|
+
.SH "SYNOPSIS"
|
|
5
|
+
.P
|
|
6
|
+
\fBase spec\fR \[lB]\fB-h\fR|\fB--help\fR\[rB]
|
|
7
|
+
.P
|
|
8
|
+
\fBase spec lint\fR \[lB]\fB-v\fR|\fB--verbose\fR\[rB]
|
|
9
|
+
.P
|
|
10
|
+
\fBase spec export\fR \[lB]\fB-o\fR|\fB--output\fR \[lB]\fIformat\fR\fB:\fR\[rB]\fIfile\fR\[rB] \[lB]...\[rB] \[lB]\fB-w\fR|\fB--watch\fR\[rB]
|
|
11
|
+
.P
|
|
12
|
+
\fBase spec preview\fR \[lB]\fB-a\fR|\fB--addr\fR \fIip-addr\fR\[rB] \[lB]\fB-p\fR|\fB--port\fR \fItcp-port\fR\[rB]
|
|
13
|
+
.SH "DESCRIPTION"
|
|
14
|
+
.P
|
|
15
|
+
\fBase spec\fR is the entry point group for linting, exporting, and previewing the \fISpecBook\fR-based project specification (SPEC), i.e., the Markdown files (plus their embedded assets) of the artifact kind \fBspec\fR below the base directory \fBproject.artifact.spec.basedir\fR (default: \fBdocs/specbook\fR, relative to the project root).
|
|
16
|
+
.P
|
|
17
|
+
The specification is governed by the \fISpecBook\fR YAML schema configuration \fBproject.artifact.spec.schema\fR: a whitespace-separated list of schema files, merged in the given order, where the entry \fBstd\fR names the standard schema \fBase-format-specbook.yaml\fR bundled with the plugin (see \fBase-util-meta\fR(1)) and every other entry is a file path relative to the project root. An unset or empty value means \fBstd\fR.
|
|
18
|
+
.P
|
|
19
|
+
All specification commands honor the Git exclude rules exactly like \fBase artifact list\fR does (see \fBase-artifact\fR(1)): an artifact file Git excludes from the project counts as an \fIabsent\fR one, so both resolvers always see the very same specification.
|
|
20
|
+
.P
|
|
21
|
+
The \fISpecBook\fR processing information is logged at the \fBinfo\fR level and its tracing details at the \fBdebug\fR level (see the global option \fB--log-level\fR of \fBase\fR(1)).
|
|
22
|
+
.P
|
|
23
|
+
Without a sub-command, the usage information is shown and the command exits with status \fB1\fR.
|
|
24
|
+
.SH "OPTIONS"
|
|
25
|
+
.RS 0
|
|
26
|
+
.IP \(bu 4
|
|
27
|
+
\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show usage information and exit.
|
|
28
|
+
.RE 0
|
|
29
|
+
.SH "COMMANDS"
|
|
30
|
+
.RS 0
|
|
31
|
+
.IP \(bu 4
|
|
32
|
+
\fBase spec lint\fR \[lB]\fB-v\fR|\fB--verbose\fR\[rB]: Lint the specification against the schema configuration. See \fBase-spec-lint\fR(1).
|
|
33
|
+
.IP \(bu 4
|
|
34
|
+
\fBase spec export\fR \[lB]\fB-o\fR|\fB--output\fR \[lB]\fIformat\fR\fB:\fR\[rB]\fIfile\fR\[rB] \[lB]...\[rB] \[lB]\fB-w\fR|\fB--watch\fR\[rB]: Export the specification as JSON, JSON5, YAML, TOON, HTML, PDF, or normalized Markdown. See \fBase-spec-export\fR(1).
|
|
35
|
+
.IP \(bu 4
|
|
36
|
+
\fBase spec preview\fR \[lB]\fB-a\fR|\fB--addr\fR \fIip-addr\fR\[rB] \[lB]\fB-p\fR|\fB--port\fR \fItcp-port\fR\[rB]: Serve the HTML export of the specification as a live preview. See \fBase-spec-preview\fR(1).
|
|
37
|
+
.RE 0
|
|
38
|
+
.SH "EXIT STATUS"
|
|
39
|
+
.P
|
|
40
|
+
The group command without a sub-command exits with status \fB1\fR.
|
|
41
|
+
.SH "SEE ALSO"
|
|
42
|
+
.P
|
|
43
|
+
\fBase\fR(1), \fBase-spec-lint\fR(1), \fBase-spec-export\fR(1), \fBase-spec-preview\fR(1), \fBase-artifact\fR(1), \fBase-config\fR(1).
|
|
44
|
+
.SH "AUTHOR"
|
|
45
|
+
.P
|
|
46
|
+
Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR
|