### aiplus quickstart command example

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.6.x-stabilization.md

An example of the interactive command-line interface for the `aiplus quickstart` command, demonstrating user prompts and setup progress.

```bash
$ aiplus quickstart

Welcome to AiPlus! Let's get you set up in 3 questions.

[1/3] Which AI coding agent are you using?
  > Claude Code
    Codex
    OpenCode
    I don't have one yet (show install links)

[2/3] Do you want AEL (applied-economics research team)?
  > Yes (I'm a researcher / academic)
    No (just software engineering)

[3/3] Where should AiPlus install in this project?
  > /current/directory (auto-detected)

Setting up...
✓ Installed claude-code adapter
✓ Set up secret-broker (your key stays in OS keychain)
✓ Added AEL research-team module
✓ Verified everything with aiplus doctor

All set! Try: `ael talk advisor "What is your role?"`

```

--------------------------------

### Install a profile

Source: https://github.com/izhiwen/aiplus/blob/main/docs/profile-bundle-guide.md

Commands to install a profile, with options for dry run and automatic confirmation.

```bash
aiplus profile install my-profile --user --source /path/to/profile-source --dry-run
aiplus profile install my-profile --user --source /path/to/profile-source --yes
```

--------------------------------

### Installation and Setup

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/outreach/twitter-thread.md

Command-line instructions to download, install, and set up the AiPlus CLI.

```shell
curl -L github.com/izhiwen/AiPlus/releases/latest/download/aiplus-aarch64-apple-darwin.tar.gz | tar xz
sudo mv aiplus /usr/local/bin/
cd MyProject && aiplus install codex
```

--------------------------------

### aiplus Initial Setup Output

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/lobby-1-impl-notes.md

Transcript excerpt showing the output of the `aiplus` command during initial setup, including adapter installation and the role selection prompt.

```text
✦ aiplus: this project is not set up yet. Setting up...
  → installing claude-code adapter (skipped: claude CLI not on PATH)
  → installing codex adapter ✓
  → installing opencode adapter (skipped: opencode CLI not on PATH)
  → registered MCP server with available runtimes
  ✓ Team ready.

✦ Who do you want to talk to?

  Core team (current active team: agent-team):
    advisor / Advisor            反思、识别策略、框架
    ceo / CEO                    全局协调（默认）
    architect / Architect        系统设计、技术选型
    pm / PM                      派单、跟进
    engineer-a / Engineer A      实现
    engineer-b / Engineer B      实现（并行）
    reviewer / Reviewer          代码 review
    qa / QA                      测试

> [Enter for ceo, or type role name / partial match] → ceo
→ codex
[Launching codex with ceo persona...]
Opening runtime=codex session as role=ceo — persona loaded from .aiplus/agents/personas/ceo.md
talk_audit runtime=codex role=ceo persona=.aiplus/agents/personas/ceo.md
```

--------------------------------

### Runtime Installation and Reconciliation

Source: https://github.com/izhiwen/aiplus/blob/main/CHANGELOG.md

Example of installing a runtime and reconciling installed modules.

```bash
aiplus install <runtime>
```

--------------------------------

### Setup Commands

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/docs/beta-walkthrough.md

Commands to initialize a new project directory, set up git, and install aiplus with the aieconlab package.

```bash
mkdir /tmp/treaty-ports-test && cd /tmp/treaty-ports-test
git init -q -b main
aiplus install codex
aiplus add aieconlab
git add -A && git commit -qm "init"
```

--------------------------------

### Upgrade from pre-v0.4 (v0.3.x and earlier)

Source: https://github.com/izhiwen/aiplus/blob/main/UPGRADE.md

For upgrades from pre-v0.4 versions, a fresh install is recommended over an in-place upgrade.

```bash
# Back up what matters:
mv .aiplus .aiplus.v0.3-backup

# Re-install fresh on v0.5.16:
aiplus install <your-runtime>
```

--------------------------------

### AiPlus Installation and Setup

Source: https://github.com/izhiwen/aiplus/blob/main/docs/user-interview-scripts.md

Commands to install AiPlus, navigate to a paper repository, and add the aieconlab integration.

```bash
curl -fsSL https://raw.githubusercontent.com/izhiwen/AiPlus/main/install.sh | bash
cd ~/some-paper-repo   # their actual repo
aiplus install claude-code
aiplus add aieconlab
```

--------------------------------

### Setup Commands

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/agent-autoflow-discovery-impl-notes.md

Commands to set up the discovery test environment, including removing old directories, creating new ones, copying the aiplus binary, and installing all components.

```text
rm -rf /tmp/discovery-test
mkdir -p /tmp/discovery-test/project /tmp/discovery-test/bin /tmp/discovery-test/codex-home /tmp/discovery-test/home /tmp/discovery-test/xdg
cp target/debug/aiplus /tmp/discovery-test/bin/aiplus
HOME=/tmp/discovery-test/home XDG_CONFIG_HOME=/tmp/discovery-test/xdg CODEX_HOME=/tmp/discovery-test/codex-home /tmp/discovery-test/bin/aiplus install all --yes --allow-version-skew
CODEX_HOME=/tmp/discovery-test/codex-home /tmp/discovery-test/bin/aiplus mcp-register --runtime codex --force
```

--------------------------------

### Quick start

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-agent-velocity/README.md

Install and initialize AiPlus Agent Velocity.

```bash
cd MyProject
aiplus install claude-code    # or: codex, opencode, all
aiplus velocity init
```

--------------------------------

### Help Command Example

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/core/templates/personas/reproducibility.md

Demonstrates how to get help for the main command-line tool or specific subcommands.

```bash
ael --help
```

```bash
ael <tool> --help
```

--------------------------------

### OpenCode Phase 3 Setup

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/agent-autoflow-discovery-2-impl-notes.md

Commands to install, register, and configure OpenCode for Phase 3.

```bash
HOME=/tmp/discovery-v2-ratify/home \
XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg \
/tmp/discovery-v2-ratify/bin/aiplus install all --yes --allow-version-skew

HOME=/tmp/discovery-v2-ratify/home \
XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg \
/tmp/discovery-v2-ratify/bin/aiplus mcp-register --runtime opencode --force

HOME=/tmp/discovery-v2-ratify/home \
XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg \
/tmp/discovery-v2-ratify/bin/aiplus mcp-register --runtime opencode --config-dir .opencode --force
```

--------------------------------

### Commands for OpenCode Project

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-compact-reminder/examples/opencode-project/README.md

This snippet shows the bash commands to install, prepare, validate, and checkpoint an OpenCode project using AiPlus CLI.

```bash
cd <TARGET_PROJECT>
aiplus install opencode
aiplus compact prepare
aiplus compact validate
aiplus compact checkpoint
```

--------------------------------

### Starting a session

Source: https://github.com/izhiwen/aiplus/blob/main/docs/daily-workflows.md

To start a session, use the `AiPlus refresh` command. The agent should report its status, including installed modules, memory record count, compact state, and profile presence.

```text
AiPlus refresh
```

--------------------------------

### Recommended Success Copy for Install Refresh

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.7.6-project-refresh-ux-design.md

Example output when the project refresh command is successful.

```text
INSTALL_REFRESH
scope=project-local
runtimeAdapters=[codex,claude-code]
modulesRefreshed=[agent-team:0.3.0->0.3.1]
managedBlocks=refreshed
localMemory=preserved
runtimeState=preserved
global_agent_config_edits=none
secret_values=none
INSTALL_REFRESH_STATUS=PASS
```

--------------------------------

### Example Row

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-agent-key/core/example-aliases.md

An example row demonstrating how an alias, backend path, and environment variable name are mapped.

```text
openai	zhiwen/openai/api_key	OPENAI_API_KEY
```

--------------------------------

### Install AiPlus

Source: https://github.com/izhiwen/aiplus/blob/main/README.md

This installs the `aiplus` command on your machine.

```bash
curl -fsSL https://raw.githubusercontent.com/izhiwen/AiPlus/main/install.sh | bash
```

--------------------------------

### Verify CLI Installation

Source: https://github.com/izhiwen/aiplus/blob/main/docs/getting-started.md

Checks if the AiPlus CLI has been installed correctly.

```bash
aiplus --version
```

--------------------------------

### Demo Script: Beat 1 - Setup Project Directory

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/docs/demo-script.md

Initializes a new project directory and a git repository.

```bash
$ mkdir my-paper && cd my-paper
$ git init -q -b main
```

--------------------------------

### Developer Build - Install into project

Source: https://github.com/izhiwen/aiplus/blob/main/docs/getting-started.md

Installs the AiPlus CLI from a developer build into a target project.

```bash
~/aiplus/target/release/aiplus install codex
```

--------------------------------

### Identity Fields Example

Source: https://github.com/izhiwen/aiplus/blob/main/docs/identity-guide.md

Example TOML structure for defining a role identity.

```toml
id = "aiplus.advisor.default"
role = "Advisor"
scope = "project"
activation = ["advice", "brainstorm"]
output_contract = "concise options"
owner_gates = ["publish", "deploy"]
inherits = []

# v2 fields
role_contract = "Provide options with trade-offs"
scope_boundaries = ["project files only"]
current_responsibilities = ["review plans", "suggest alternatives"]
allowed_actions = ["read", "suggest"]
forbidden_actions = ["execute", "deploy", "publish"]
```

--------------------------------

### Reproducibility Walkthrough

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/docs/beta-walkthrough.md

Commands to set up and run the walkthrough locally to compare output with captured findings.

```bash
mkdir /tmp/aiel-test && cd /tmp/aiel-test
git init -q -b main
aiplus install codex
aiplus add aieconlab
git add -A && git commit -qm "init"

aiplus agent status
aiplus agent route pi "kickoff Treaty Ports paper"
aiplus agent route theorist "write identification note for treaty-port IV strategy"
aiplus agent route llm-measurement "design validity protocol for scoring 19th-century Chinese documents across 5 LLMs"
cat .aiplus/agents/dispatch-log.jsonl
aiplus agent doctor 2>&1 | tail -30
```

--------------------------------

### Setup Commands

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/agent-autoflow-discovery-2-impl-notes.md

Commands to set up the discovery environment, including cleaning up previous runs, creating directories, copying binaries and auth files, initializing a git repository, and installing/registering MCP runtimes.

```bash
rm -rf /tmp/discovery-v2-ratify
mkdir -p /tmp/discovery-v2-ratify/{bin,project,codex-home,home,xdg}
cp target/debug/aiplus /tmp/discovery-v2-ratify/bin/aiplus
cp ~/.codex/auth.json /tmp/discovery-v2-ratify/codex-home/auth.json
cd /tmp/discovery-v2-ratify/project
git init -q && git commit --allow-empty -q -m "init / 初始化"
HOME=/tmp/discovery-v2-ratify/home XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg CODEX_HOME=/tmp/discovery-v2-ratify/codex-home AIPLUS_SKIP_VERSION_CHECK=1 /tmp/discovery-v2-ratify/bin/aiplus install all --yes
CODEX_HOME=/tmp/discovery-v2-ratify/codex-home /tmp/discovery-v2-ratify/bin/aiplus mcp-register --runtime codex --force
HOME=/tmp/discovery-v2-ratify/home XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg /tmp/discovery-v2-ratify/bin/aiplus mcp-register --runtime opencode --force
HOME=/tmp/discovery-v2-ratify/home XDG_CONFIG_HOME=/tmp/discovery-v2-ratify/xdg /tmp/discovery-v2-ratify/bin/aiplus mcp-register --runtime opencode --config-dir .opencode --force
```

--------------------------------

### Pre-recording Checklist: Prompt and Test Directory Setup

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/docs/demo-script.md

Sets up a clean terminal prompt and a fresh temporary directory for recording the demo, ensuring no irrelevant files or configurations interfere.

```bash
PS1='\W $ '
mkdir -p /tmp/demo && cd /tmp/demo && rm -rf .git .aiplus
```

--------------------------------

### Profile Supplemental Bundle Installation Command

Source: https://github.com/izhiwen/aiplus/blob/main/RELEASE_READINESS_PACKET_v0.5.1.md

Example command for installing a profile with supplemental files.

```shell
aiplus profile install aiplus-work-with-zhiwen --user --source ... --yes
```

--------------------------------

### Auto-capture example

Source: https://github.com/izhiwen/aiplus/blob/main/docs/memory-guide.md

Example of adding memory with an explicit risk level. Auto-capture classifies risk and automatically writes or blocks based on the classification.

```bash
aiplus memory add --text "Prefer 4 spaces for indentation" --risk low
```

--------------------------------

### Initialize identities

Source: https://github.com/izhiwen/aiplus/blob/main/docs/identity-guide.md

Creates the .aiplus/identities/ directory with default templates.

```bash
aiplus identity init --project
```

--------------------------------

### Check status

Source: https://github.com/izhiwen/aiplus/blob/main/docs/profile-bundle-guide.md

Commands to check the status of installed profiles.

```bash
aiplus profile status
aiplus profile status my-profile
```

--------------------------------

### One-time recommended action for v0.5.x upgrades

Source: https://github.com/izhiwen/aiplus/blob/main/UPGRADE.md

These commands are recommended to run once per project after upgrading to v0.5.16 to ensure full functionality.

```bash
aiplus doctor --check-keyring   # verify OS keyring path works
aiplus mcp-register             # wire up MCP for your installed runtimes
```

--------------------------------

### Temporary Fixture Setup

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.7.4-integration-manager-redogfood-plan.md

Creates a temporary directory and initializes a clean git fixture project for testing.

```bash
TMP=$(mktemp -d /tmp/aiplus-im-redogfood.XXXXXX)
P="$TMP/Fixture"
mkdir -p "$P" "$TMP/home" "$TMP/xdg" "$TMP/codex"
cd "$P"
git init -q
git config user.email dogfood@example.invalid
git config user.name "Dogfood User"
printf '# Fixture\n' > README.md
git add README.md
git commit --no-verify -q -m initial
```

--------------------------------

### Usage Examples

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-token-cost/README.md

Examples of how to run the aiplus-token-cost command with different options.

```bash
aiplus-token-cost
aiplus-token-cost --by-role
aiplus-token-cost --window 24h
aiplus-token-cost --top-n 10
aiplus agent token-cost
```

--------------------------------

### Initialize compact files

Source: https://github.com/izhiwen/aiplus/blob/main/docs/compact-guide.md

This command creates the necessary template files in the '.codex/compact/' directory and can be safely re-run.

```bash
aiplus compact init
```

--------------------------------

### Commands

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-compact-reminder/examples/codex-project/README.md

Commands to install, prepare, validate, and checkpoint the AiPlus Compact Reminder for a Codex project.

```bash
cd <TARGET_PROJECT>
aiplus install codex
aiplus compact prepare
aiplus compact validate
aiplus compact checkpoint
```

--------------------------------

### Module Reconciliation Example

Source: https://github.com/izhiwen/aiplus/blob/main/CHANGELOG.md

Example of adding a module and reconciling runtime adapters.

```bash
aiplus add <module>
```

--------------------------------

### Load Adapter

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-compact-reminder/examples/claude-code-project/README.md

Commands to install the Claude Code adapter and refresh the Claude Code session.

```bash
cd <TARGET_PROJECT>
aiplus install claude-code
```

```text
刷新
```

```text
/aiplus-compact-reminder:compact-validate
/aiplus-compact-reminder:compact-checkpoint
/aiplus-compact-reminder:compact-resume
```

--------------------------------

### OpenCode Users - Adapter Configuration Copy

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-compact-reminder/docs/migration-from-codex-compact-protocol.md

Command to copy the OpenCode adapter configuration example.

```bash
cp <REPO_ROOT>/aiplus-compact-reminder/adapters/opencode/opencode.json.example <TARGET_PROJECT>/.opencode/opencode.json
```

--------------------------------

### Scenario I: power-user shortcut

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/talk-resume.md

Examples of power-user shortcuts for starting or resuming sessions without the lobby.

```bash
$ aiplus agent talk advisor              # skips lobby, starts NEW (today's behavior)
$ aiplus agent talk --resume advisor     # skips lobby, resume most recent advisor session
$ ael advisor                            # skips lobby, starts NEW
$ ael talk --resume advisor              # skips lobby, resume
```

--------------------------------

### Initialize Fixture Environment

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.7.4-post-release-smoke-plan.md

Sets up a temporary directory and initializes a Git repository for fixture smoke testing.

```bash
BIN="$(command -v aiplus)"
TMP="$(mktemp -d /tmp/aiplus-v074-post-smoke.XXXXXX)"
P="$TMP/Fixture"
mkdir -p "$P" "$TMP/home" "$TMP/xdg" "$TMP/codex"
cd "$P"
git init -q
git config user.email dogfood@example.invalid
git config user.name "Dogfood User"
printf '# Fixture\n' > README.md
git add README.md
git commit --no-verify -q -m initial
```

--------------------------------

### Estimate Command

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aiplus-agent-velocity/DESIGN.md

Example of using the `aiplus velocity estimate` command to get an AI-native estimate for a task.

```bash
aiplus velocity estimate \
  --task-type compact-hardening \
  --human-estimate 5h \
  --model kimi-k2.7 \
  --workflow HEAVY
```

--------------------------------

### Launch-ready remains manual

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.7.4-async-supervision-acceptance.md

Shows how to configure agents for 'launch_ready' mode, which requires manual initiation and does not spawn automatically.

```bash
AIPLUS_AGENT_EXEC_BACKEND=codex \
AIPLUS_AGENT_EXEC_NATIVE_MODE=launch_ready \
aiplus agent route --execute qa "verify launch ready"
aiplus agent status --json
```

--------------------------------

### AiPlus CLI Commands for Codex Integration

Source: https://github.com/izhiwen/aiplus/blob/main/assets/aieconlab/adapters/codex/README.md

Examples of how to use the AiPlus CLI to install and interact with the Codex adapter.

```bash
aiplus install codex          # installs Codex-specific managed block in AGENTS.md
aiplus agent route pi <task>  # creates worktree, logs dispatch
aiplus agent talk pi          # spawns the Codex CLI with pi.md pre-loaded
```

--------------------------------

### Developer Build - Clone and Build

Source: https://github.com/izhiwen/aiplus/blob/main/docs/getting-started.md

Clones the AiPlus repository and builds the release version if no pre-built asset exists for the platform.

```bash
git clone https://github.com/izhiwen/aiplus.git
cd aiplus
cargo build --release
```

--------------------------------

### Recommended Dry-Run Copy for Install Refresh

Source: https://github.com/izhiwen/aiplus/blob/main/docs/proposals/v0.7.6-project-refresh-ux-design.md

Example output when the project refresh command is run with the --dry-run flag.

```text
INSTALL_REFRESH
DRY_RUN=YES
scope=project-local
wouldRefresh=[.aiplus/modules/aiplus-agent-team,.aiplus/AGENTS.aiplus.md,runtime-adapters]
wouldPreserve=[.aiplus/agent-memory,.aiplus/memory,.aiplus/compact,.aiplus/agents/execution-state.json,.aiplus/agents/runtime-logs]
global_agent_config_edits=none
secret_values=none
INSTALL_REFRESH_STATUS=DRY_RUN
```