plan-cli

plan-cli is the DP Assistant counterpart to guancli.

This first version deliberately does not add DP backend APIs. It wraps existing DP HTTP APIs and exposes stable JSON-oriented commands for Decidex agents and implementation engineers.

Install and Run

Global install from npm:

npm install -g plan-cli
plan-cli --help

Run without installing:

npx plan-cli --help

From the repository root:

pnpm plan-cli -- --help
pnpm plan-cli -- auth login
pnpm plan-cli -- dataset list

Directly from this package:

pnpm --dir cli/plan-cli plan-cli --help

Configuration

By default, config is stored in the OS user config directory:

• macOS: ~/Library/Application Support/plan-cli/config.json
• Linux: ~/.config/plan-cli/config.json
• Windows: %AppData%\plan-cli\config.json

For Decidex runtime injection, set:

PLANCLI_CONFIG_DIR=/path/to/.plan-cli

Profiles follow the same operating model as guancli: one profile contains one DP environment base URL and its access/refresh token material.

Command Surface

Authentication:

plan-cli auth login
plan-cli auth login --profile customer-dp --base-url https://dp.example.com --login-id user --password '...'
plan-cli auth status --profile customer-dp
plan-cli auth list
plan-cli auth use customer-dp

Datasets:

plan-cli dataset list
plan-cli dataset search 销售
plan-cli dataset meta --dataset-id 1
plan-cli dataset preview --dataset-id 1 --limit 20
plan-cli dataset list --json
plan-cli dataset meta --dataset-id 1 --json
plan-cli dataset preview --dataset-id 1 --limit 20 --json
plan-cli dataset import --spec dataset.json --dry-run --json
plan-cli dataset import --spec dataset.json --apply --json
plan-cli dataset sync --dataset-id 1 --spec sync.json --json

dataset list, dataset search, dataset meta, and dataset preview default to human-readable output. Add --json to keep the raw machine-readable API response.

Planning tables and cards:

plan-cli page init --spec page.json --json
plan-cli page save --spec page.json --json
plan-cli card init --spec card.json --json
plan-cli card preview --card-id cd_xxx --spec table-filter.json --limit 50 --json

Plans:

plan-cli plan list --json
plan-cli plan meta --plan-id plan_xxx --json
plan-cli plan preview --spec rolling-plan.json --json
plan-cli plan add --spec rolling-plan.json --json
plan-cli plan sync --plan-id plan_xxx --json

Tasks:

plan-cli task get --task-id task_xxx --json
plan-cli task latest-state --task-type PLAN_SYNC --object-id plan_xxx --json
plan-cli task wait --task-id task_xxx --timeout 600 --json

Raw API access:

plan-cli fetch GET /api/meta/app/version/info --json
plan-cli fetch POST /api/dataset/list '{"orderBy":"update_time","orderType":"desc"}' --json

Dry-Run Boundary

Because this version does not add backend APIs, --dry-run is a CLI preflight. It validates the local spec shape and reports the DP APIs that would be called. It does not provide transaction-level guarantees inside DP Assistant.