@rse/ase 2.0.3 → 2.0.4

package/dst/man/ase.1

@@ -1,124 +0,0 @@
-.TH "ASE" "1" "October 2026" "2.0.3" "Agentic Software Engineering (ASE)"
-.SH "NAME"
-\fBase\fR - Agentic Software Engineering (ASE)
-.SH "SYNOPSIS"
-.P
-\fBase\fR \[lB]\fB-h\fR|\fB--help\fR\[rB] \[lB]\fB-V\fR|\fB--version\fR\[rB] \[lB]\fB-l\fR|\fB--log-level\fR \fIlevel\fR\[rB] \[lB]\fB-L\fR|\fB--log-file\fR \fIfile\fR\[rB] \fIcommand\fR \[lB]\fIoptions\fR \[lB]...\[rB]\[rB] \[lB]\fIargs\fR \[lB]...\[rB]\[rB]
-.SH "DESCRIPTION"
-.P
-\fBase\fR, \fIAgentic Software Engineering (ASE)\fR, is the command-line companion tool of the \fIASE\fR agent tool plugin for \fIAnthropic Claude Code CLI\fR (primary target), \fIGitHub Copilot CLI\fR, and \fIOpenAI Codex CLI\fR (secondary targets).
-.P
-It provides the plugin and tool setup, the layered configuration management, a per-project background HTTP service (bridged into the agent tool as a Model-Context-Protocol (MCP) server), the agent tool hook handlers, the statusline rendering, the persisted task plan management (including a task store server and an interactive task board), the autonomous task lifecycle agents (plus their agent relay and fleet supervisor), the project artifact resolution, the \fISpecBook\fR-based specification linting, exporting and previewing, and miscellaneous utilities like diagram rendering, identifier minting, and text measuring.
-.P
-Most commands are sub-command groups. Each group and each command has its own manual page, named after the command path with dashes, e.g., \fBase-task\fR(1) for \fBase task\fR and \fBase-task-board\fR(1) for \fBase task
-board\fR. They are shipped with \fBase\fR and shown via \fBase man\fR, e.g., \fBase man task board\fR.
-.SH "OPTIONS"
-.P
-The following top-level (global) options exist. They have to be given \fIbefore\fR the \fIcommand\fR, as all options after the \fIcommand\fR belong to the command itself.
-.RS 0
-.IP \(bu 4
-\[lB]\fB-h\fR|\fB--help\fR\[rB]: Show program usage information, including the list of all top-level commands, and exit. Every command and sub-command also accepts \fB-h\fR|\fB--help\fR to show its own usage information. Alternatively, \fBase
-help\fR \[lB]\fIcommand\fR\[rB] shows the usage information of \fIcommand\fR.
-.IP \(bu 4
-\[lB]\fB-V\fR|\fB--version\fR\[rB]: Show program version information (as \fBASE\fR \fIversion\fR) and exit.
-.IP \(bu 4
-\[lB]\fB-l\fR|\fB--log-level\fR \fIlevel\fR\[rB]: Set the logging verbosity. Supported \fIlevel\fR values are \fBerror\fR, \fBwarning\fR, \fBinfo\fR (default), and \fBdebug\fR. Log messages of a level above the selected one are suppressed. The level is passed on to all background processes (like the service, the task store, the agent relay, and the agents) started by the command.
-.IP \(bu 4
-\[lB]\fB-L\fR|\fB--log-file\fR \fIfile\fR\[rB]: Redirect log output to \fIfile\fR (appended). Use \fB-\fR (default) to write log messages to standard error. If the log output is connected to a terminal, it is colored.
-.RE 0
-.SH "COMMANDS"
-.P
-The following top-level commands exist:
-.RS 0
-.IP \(bu 4
-\fBase setup\fR \fIcommand\fR \[lB]...\[rB]: Install, update, uninstall, enable, disable, and report the \fIASE\fR tool and plugin for an agent tool, and activate or deactivate the pre-defined foreign MCP servers, the \fIASE\fR statusline, and the \fIASE\fR telemetry export. See \fBase-setup\fR(1).
-.IP \(bu 4
-\fBase config\fR \[lB]\fB--scope\fR \fIscope\fR\[rB] \fIcommand\fR \[lB]...\[rB]: Manage the layered \fIASE\fR configuration of the scope chain \fBuser\fR < \fBproject\fR < \fBtask\fR < \fBsession\fR. See \fBase-config\fR(1).
-.IP \(bu 4
-\fBase mcp\fR: Bridge stdio MCP to the per-project background service. Configured as an MCP server in the agent tool. See \fBase-mcp\fR(1).
-.IP \(bu 4
-\fBase service\fR \fIcommand\fR \[lB]...\[rB]: Manage the per-project background HTTP service. See \fBase-service\fR(1).
-.IP \(bu 4
-\fBase hook\fR \fIcommand\fR \[lB]...\[rB]: Handle the hook events of the agent tool. Configured as hook handlers in the agent tool. See \fBase-hook\fR(1).
-.IP \(bu 4
-\fBase statusline\fR \[lB]\fIoptions\fR\[rB] \[lB]\fIline\fR \[lB]...\[rB]\[rB]: Render the statusline of the agent tool. Configured as statusline command in the agent tool. See \fBase-statusline\fR(1).
-.IP \(bu 4
-\fBase task\fR \fIcommand\fR \[lB]...\[rB]: Manage the persisted task plans in the task store, show the task board, and run the task store server. See \fBase-task\fR(1).
-.IP \(bu 4
-\fBase artifact\fR \fIcommand\fR \[lB]...\[rB]: Resolve project artifact kinds to project-relative file lists. See \fBase-artifact\fR(1).
-.IP \(bu 4
-\fBase spec\fR \fIcommand\fR \[lB]...\[rB]: Lint, export, and preview the \fISpecBook\fR-based project specification. See \fBase-spec\fR(1).
-.IP \(bu 4
-\fBase util\fR \fIcommand\fR \[lB]...\[rB]: Utility commands (meta files, compatibility probes, diagram rendering, worktree resolution, identifier minting, and text measuring). See \fBase-util\fR(1).
-.IP \(bu 4
-\fBase agent\fR \fIagent\fR \fIcommand\fR \[lB]...\[rB]: Run the autonomous agents driving the task lifecycle phases, processing the requests of tasks, estimating the effort of tasks, researching topics for tasks, or configured by definitions, individually or as a fleet, optionally reporting to the agent relay. See \fBase-agent\fR(1).
-.IP \(bu 4
-\fBase man\fR \[lB]\fIpage\fR \[lB]...\[rB]\[rB]: Show one of the manual pages shipped internally with \fBase\fR with \fBman\fR(1), e.g., \fBase man agent fleet\fR for \fBase-agent-fleet\fR(1). See \fBase-man\fR(1).
-.IP \(bu 4
-\fBase help\fR \[lB]\fIcommand\fR\[rB]: Show the usage information of \fIcommand\fR (or of \fBase\fR itself).
-.RE 0
-.SH "ENVIRONMENT"
-.P
-The following environment variables are honored by multiple commands. The command-specific ones are described in their own manual pages.
-.RS 0
-.IP \(bu 4
-\fBASE_TOOL\fR: The default target agent tool (\fBclaude\fR, \fBcopilot\fR, or \fBcodex\fR) of all commands accepting a \fB--tool\fR option (default: \fBclaude\fR).
-.IP \(bu 4
-\fBASE_TASK_ID\fR: The default task id of the \fBase task\fR commands accepting an optional task id (default: \fBdefault\fR).
-.IP \(bu 4
-\fBASE_HEADLESS\fR: Set to \fBtrue\fR by the agents for the agent tool processes they spawn, to signal the skills that they run without any user interaction.
-.IP \(bu 4
-\fBASE_SETUP_DEV\fR: The default of the \fB--dev\fR option of \fBase setup install\fR, \fBase setup
-update\fR, and \fBase setup uninstall\fR.
-.IP \(bu 4
-\fBEDITOR\fR, \fBVISUAL\fR: The text editor used by \fBase config edit\fR, \fBase task edit\fR, and \fBase task board\fR (falling back to \fBvi\fR).
-.IP \(bu 4
-\fBPAGER\fR: The pager used by \fBase task view\fR (falling back to \fBmore\fR).
-.IP \(bu 4
-\fBXDG_CONFIG_HOME\fR, \fBXDG_STATE_HOME\fR, \fBAPPDATA\fR, \fBLOCALAPPDATA\fR: The base directories of the \fIper-user configuration directory\fR and the \fIper-user state directory\fR (see \fBFILES\fR).
-.RE 0
-.SH "FILES"
-.RS 0
-.IP \(bu 4
-\fIper-user configuration directory\fR: The per-user \fIASE\fR configuration directory: \fB~/Library/Application
-Support/ase\fR on macOS, \fB%APPDATA%\[rs]ase\fR on Windows, and \fB$XDG_CONFIG_HOME/ase\fR (falling back to \fB~/.config/ase\fR) on Linux and other Unix systems. It holds the \fBuser\fR scope configuration \fBconfig.yaml\fR, the user agent definitions \fBagents/\fR, and the state of the task store server (\fBstore.yaml\fR, \fBstore.log\fR, \fBtasks/\fR) and agent relay server (\fBrelay.yaml\fR, \fBrelay.log\fR).
-.IP \(bu 4
-\fIper-user state directory\fR: The machine-local per-user \fIASE\fR state (session configurations, task lifecycle deviation warnings, agent run records, and telemetry state), never roamed or versioned: \fB~/Library/Application
-Support/ase\fR on macOS, \fB%LOCALAPPDATA%\[rs]ase\fR on Windows, and \fB$XDG_STATE_HOME/ase\fR (falling back to \fB~/.local/state/ase\fR) on Linux and other Unix systems.
-.IP \(bu 4
-\fB.ase/\fR: The per-project \fIASE\fR directory in the project root, holding the \fBproject\fR scope configuration \fBconfig.yaml\fR, the agent definitions \fBagents/\fR, the fleet configuration \fBfleet.yaml\fR, the task plans \fBtask/\fR of the default local task store, and the machine-local runtime files (\fBservice.yaml\fR, \fBservice.log\fR, \fBboard.yaml\fR, \fBagent/\fR, and \fBworktree/\fR), the latter covered by the self-ignoring \fB.ase/.gitignore\fR.
-.RE 0
-.SH "EXIT STATUS"
-.P
-The \fBase\fR command exits with status \fB0\fR on success and with status \fB1\fR on any error (with the error message logged at level \fBerror\fR), unless a command documents otherwise. A usage error (an unknown command or option, or a missing argument) is reported together with the usage information and leads to exit status \fB1\fR.
-.SH "EXAMPLES"
-.P
-.RS 2
-.nf
-# install the ASE tool and plugin for Anthropic Claude Code CLI
-$ ase setup install
-
-# show the effective configuration of the current project
-$ ase config list
-
-# list all open task plans with their status and title
-$ ase task list -v
-
-# show the interactive task board
-$ ase task board
-
-# start the fleet of agents of ".ase/fleet.yaml"
-$ ase agent fleet start
-.fi
-.RE
-.SH "SEE ALSO"
-.P
-\fBase-setup\fR(1), \fBase-config\fR(1), \fBase-mcp\fR(1), \fBase-service\fR(1), \fBase-hook\fR(1), \fBase-statusline\fR(1), \fBase-task\fR(1), \fBase-artifact\fR(1), \fBase-spec\fR(1), \fBase-util\fR(1), \fBase-agent\fR(1), \fBase-man\fR(1), \fBclaude\fR(1), \fBcopilot\fR(1), \fBcodex\fR(1), \fBgit\fR(1).
-.P
-\fI\(lahttps://ase.tools\(ra\fR
-.SH "HISTORY"
-.P
-Development of \fBase\fR(1) started in October 2025.
-.SH "AUTHOR"
-.P
-Dr. Ralf S. Engelschall \fI\(larse@engelschall.com\(ra\fR