Files
cleveragents-core/docs/reference/cli_inventory.yaml
T

1214 lines
29 KiB
YAML

root:
name: root
use: plandex [command] [flags]
aliases: []
short_description: 'Plandex: iterative development with AI'
long_description: ''
flags: []
subcommands:
- helpCmd
- connectClaudeCmd
- disconnectClaudeCmd
parent: null
run_function: func
file_path: /app/plandex/app/cli/cmd/root.go
requires_auth: false
requires_project: false
requires_plan: false
hidden: false
commands:
apply:
name: apply
use: apply
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/apply.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
archive:
name: archive
use: archive [name-or-index]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/archive.go
requires_auth: true
requires_project: true
requires_plan: false
hidden: false
billing:
name: billing
use: billing
aliases: []
short_description: Open the billing page in the browser
long_description: ''
flags: []
subcommands: []
parent: null
run_function: billing
file_path: /app/plandex/app/cli/cmd/billing.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
branches:
name: branches
use: branches
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/branches.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
browser:
name: browser
use: browser [urls...]
aliases: []
short_description: Open browser windows with given URLs, capturing console logs
and exiting on JS errors
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/browser.go
requires_auth: false
requires_project: false
requires_plan: false
hidden: false
build:
name: build
use: build
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/build.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
cd:
name: cd
use: cd [name-or-index]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/cd.go
requires_auth: true
requires_project: true
requires_plan: false
hidden: false
chat:
name: chat
use: chat [prompt]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/chat.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
checkout:
name: checkout
use: checkout [name-or-index]
aliases: []
short_description: ''
long_description: ''
flags:
- name: 'yes'
shorthand: y
flag_type: bool
default_value: false
description: Confirm creating a new branch
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/checkout.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
connect-claude:
name: connect-claude
use: connect-claude
aliases: []
short_description: Connect your Claude Pro or Max subscription
long_description: ''
flags: []
subcommands: []
parent: root
run_function: connectClaude
file_path: /app/plandex/app/cli/cmd/claude_max.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
disconnect-claude:
name: disconnect-claude
use: disconnect-claude
aliases: []
short_description: Disconnect your Claude Pro or Max subscription
long_description: ''
flags: []
subcommands: []
parent: root
run_function: disconnectClaude
file_path: /app/plandex/app/cli/cmd/claude_max.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
claude-status:
name: claude-status
use: claude-status
aliases: []
short_description: Check the status of your Claude Pro or Max subscription
long_description: ''
flags: []
subcommands: []
parent: null
run_function: claudeStatus
file_path: /app/plandex/app/cli/cmd/claude_max.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
clear:
name: clear
use: clear
aliases: []
short_description: Clear all context
long_description: Clear all context.
flags: []
subcommands: []
parent: null
run_function: clearAllContext
file_path: /app/plandex/app/cli/cmd/clear.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
config:
name: config
use: config
aliases: []
short_description: Show plan config
long_description: ''
flags: []
subcommands: []
parent: null
run_function: config
file_path: /app/plandex/app/cli/cmd/config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
default-config:
name: default-config
use: default
aliases: []
short_description: Show default config for new plans
long_description: ''
flags: []
subcommands: []
parent: null
run_function: defaultConfig
file_path: /app/plandex/app/cli/cmd/config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
connect:
name: connect
use: connect [stream-id-or-plan] [branch]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/connect.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
context-show:
name: context-show
use: show [name-or-index]
aliases: []
short_description: Show the body of a context by name or list index
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/context_show.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
continue:
name: continue
use: continue
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/continue.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
convo:
name: convo
use: convo [msg-range]
aliases: []
short_description: Display complete conversation history
long_description: Display complete conversation history. Optionally specify a
message number or range of messages (e.g. '1' or '5' or '1-5' or '5-')
flags:
- name: plain
shorthand: p
flag_type: bool
default_value: false
description: Output conversation in plain text with no ANSI codes
required: false
global_flag: false
subcommands: []
parent: null
run_function: convo
file_path: /app/plandex/app/cli/cmd/convo.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
current:
name: current
use: current
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/current.go
requires_auth: true
requires_project: false
requires_plan: true
hidden: false
debug:
name: debug
use: debug [tries] <cmd>
aliases: []
short_description: ''
long_description: ''
flags:
- name: commit
shorthand: c
flag_type: bool
default_value: false
description: Commit changes after successful execution
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/debug.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
delete-branch:
name: delete-branch
use: delete-branch
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/delete_branch.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
rm:
name: rm
use: delete-plan [name-or-index]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/delete_plan.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
diffs:
name: diffs
use: diff
aliases: []
short_description: ''
long_description: ''
flags:
- name: plain
shorthand: p
flag_type: bool
default_value: false
description: Output diffs in plain text with no ANSI codes
required: false
global_flag: false
- name: side
shorthand: s
flag_type: bool
default_value: true
description: Show diffs UI in side-by-side view
required: false
global_flag: false
- name: line
shorthand: l
flag_type: bool
default_value: false
description: Show diffs UI in line-by-line view
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/diffs.go
requires_auth: true
requires_project: false
requires_plan: true
hidden: false
invite:
name: invite
use: invite [email] [name] [org-role]
aliases: []
short_description: Invite a new user to the org
long_description: ''
flags: []
subcommands: []
parent: null
run_function: invite
file_path: /app/plandex/app/cli/cmd/invite.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
context-load:
name: context-load
use: load [files-or-urls...]
aliases: []
short_description: ''
long_description: ''
flags:
- name: recursive
shorthand: r
flag_type: bool
default_value: false
description: Search directories recursively
required: false
global_flag: false
- name: force
shorthand: f
flag_type: bool
default_value: false
description: Load files even when ignored by .gitignore or .plandexignore
required: false
global_flag: false
- name: note
shorthand: n
flag_type: string
default_value: ''
description: Add a note to the context
required: false
global_flag: false
- name: detail
shorthand: d
flag_type: string
default_value: high
description: Image detail level (high or low)
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/load.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
log:
name: log
use: log
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/log.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
context:
name: context
use: ls
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/ls.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
model-packs:
name: model-packs
use: model-packs
aliases: []
short_description: List all model packs
long_description: ''
flags:
- name: custom
shorthand: c
flag_type: bool
default_value: false
description: Only show custom model packs
required: false
global_flag: false
- name: all
shorthand: a
flag_type: bool
default_value: false
description: Show all properties
required: false
global_flag: false
subcommands: []
parent: null
run_function: listModelPacks
file_path: /app/plandex/app/cli/cmd/model_packs.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
create-model-pack:
name: create-model-pack
use: create
aliases: []
short_description: Create a model pack
long_description: ''
flags: []
subcommands: []
parent: null
run_function: customModelsNotImplemented
file_path: /app/plandex/app/cli/cmd/model_packs.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
delete-model-pack:
name: delete-model-pack
use: delete
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/model_packs.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
update-model-pack:
name: update-model-pack
use: update
aliases: []
short_description: Update a model pack by name
long_description: ''
flags: []
subcommands: []
parent: null
run_function: customModelsNotImplemented
file_path: /app/plandex/app/cli/cmd/model_packs.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
show-model-pack:
name: show-model-pack
use: show [name]
aliases: []
short_description: Show a model pack by name
long_description: ''
flags: []
subcommands: []
parent: null
run_function: showModelPack
file_path: /app/plandex/app/cli/cmd/model_packs.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
providers:
name: providers
use: providers
aliases: []
short_description: List built-in and custom model providers
long_description: ''
flags:
- name: custom
shorthand: c
flag_type: bool
default_value: false
description: List custom providers only
required: false
global_flag: false
subcommands: []
parent: null
run_function: listProviders
file_path: /app/plandex/app/cli/cmd/model_providers.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
add-provider:
name: add-provider
use: add
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/model_providers.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
update-provider:
name: update-provider
use: update
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/model_providers.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
models:
name: models
use: models
aliases: []
short_description: Show plan model settings
long_description: ''
flags:
- name: all
shorthand: a
flag_type: bool
default_value: false
description: Show all properties
required: false
global_flag: false
subcommands: []
parent: null
run_function: models
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
default-models:
name: default-models
use: default
aliases: []
short_description: Show default model settings for new plans
long_description: ''
flags: []
subcommands: []
parent: null
run_function: defaultModels
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
list-available-models:
name: list-available-models
use: available
aliases: []
short_description: ''
long_description: ''
flags:
- name: custom
shorthand: c
flag_type: bool
default_value: false
description: List custom models only
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
manage-custom-models:
name: manage-custom-models
use: custom
aliases: []
short_description: Manage custom models, providers, and model packs
long_description: ''
flags:
- name: file
shorthand: f
flag_type: string
default_value: ''
description: Path to custom models file
required: false
global_flag: false
subcommands: []
parent: null
run_function: manageCustomModels
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
add-custom-model:
name: add-custom-model
use: add
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
update-custom-model:
name: update-custom-model
use: update
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
delete-custom-model:
name: delete-custom-model
use: rm
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/models.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
new:
name: new
use: new
aliases: []
short_description: ''
long_description: ''
flags:
- name: name
shorthand: n
flag_type: string
default_value: ''
description: Name of the new plan
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/new.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
plans:
name: plans
use: plans
aliases: []
short_description: ''
long_description: ''
flags:
- name: archived
shorthand: a
flag_type: bool
default_value: false
description: List archived plans
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/plans.go
requires_auth: true
requires_project: false
requires_plan: true
hidden: false
ps:
name: ps
use: ps
aliases: []
short_description: List plans with active or recently finished streams
long_description: ''
flags: []
subcommands: []
parent: null
run_function: ps
file_path: /app/plandex/app/cli/cmd/ps.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
reject:
name: reject
use: reject [files...]
aliases: []
short_description: ''
long_description: ''
flags:
- name: all
shorthand: a
flag_type: bool
default_value: false
description: Reject all pending changes
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/reject.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
rename:
name: rename
use: rename [new-name]
aliases: []
short_description: Rename the current plan
long_description: ''
flags: []
subcommands: []
parent: null
run_function: rename
file_path: /app/plandex/app/cli/cmd/rename.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
repl:
name: repl
use: repl
aliases: []
short_description: Start interactive Plandex REPL
long_description: ''
flags: []
subcommands: []
parent: null
run_function: runRepl
file_path: /app/plandex/app/cli/cmd/repl.go
requires_auth: true
requires_project: false
requires_plan: true
hidden: false
revoke:
name: revoke
use: revoke [email]
aliases: []
short_description: Revoke an invite or remove a user from the org
long_description: ''
flags: []
subcommands: []
parent: null
run_function: revoke
file_path: /app/plandex/app/cli/cmd/revoke.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
rewind:
name: rewind
use: rewind [steps-or-sha]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/rewind.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
context-rm:
name: context-rm
use: rm
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/rm.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
set-config:
name: set-config
use: set-config [setting] [value]
aliases: []
short_description: Update current plan config
long_description: ''
flags: []
subcommands: []
parent: null
run_function: setConfig
file_path: /app/plandex/app/cli/cmd/set_config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
default-set-config:
name: default-set-config
use: default [setting] [value]
aliases: []
short_description: Update default plan config
long_description: ''
flags: []
subcommands: []
parent: null
run_function: defaultSetConfig
file_path: /app/plandex/app/cli/cmd/set_config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
set-auto:
name: set-auto
use: set-auto [value]
aliases: []
short_description: Update config auto-mode
long_description: ''
flags: []
subcommands: []
parent: null
run_function: setAuto
file_path: /app/plandex/app/cli/cmd/set_config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
set-auto-default:
name: set-auto-default
use: default [value]
aliases: []
short_description: Update default config auto-mode
long_description: ''
flags: []
subcommands: []
parent: null
run_function: setAutoDefault
file_path: /app/plandex/app/cli/cmd/set_config.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
models-set:
name: models-set
use: set-model [model-pack-name]
aliases: []
short_description: ''
long_description: ''
flags:
- name: file
shorthand: f
flag_type: string
default_value: ''
description: Path to model settings JSON file
required: false
global_flag: false
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/set_model.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
default-model-set:
name: default-model-set
use: default [model-pack-name]
aliases: []
short_description: Update org-wide default model settings
long_description: ''
flags:
- name: file
shorthand: f
flag_type: string
default_value: ''
description: Path to model settings JSON file
required: false
global_flag: false
subcommands: []
parent: null
run_function: defaultModelsSet
file_path: /app/plandex/app/cli/cmd/set_model.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
sign-in:
name: sign-in
use: sign-in
aliases: []
short_description: Sign in to a Plandex account
long_description: ''
flags: []
subcommands: []
parent: null
run_function: signIn
file_path: /app/plandex/app/cli/cmd/sign_in.go
requires_auth: false
requires_project: false
requires_plan: false
hidden: false
stop:
name: stop
use: stop [stream-id-or-plan] [branch]
aliases: []
short_description: Connect to an active stream
long_description: ''
flags: []
subcommands: []
parent: null
run_function: stop
file_path: /app/plandex/app/cli/cmd/stop.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
status:
name: status
use: summary
aliases: []
short_description: Show the latest summary of the current plan
long_description: ''
flags:
- name: plain
shorthand: p
flag_type: bool
default_value: false
description: Output summary in plain text with no ANSI codes
required: false
global_flag: false
subcommands: []
parent: null
run_function: status
file_path: /app/plandex/app/cli/cmd/summary.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
tell:
name: tell
use: tell [prompt]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/tell.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
unarchive:
name: unarchive
use: unarchive [name-or-index]
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/unarchive.go
requires_auth: true
requires_project: true
requires_plan: false
hidden: false
update:
name: update
use: update
aliases: []
short_description: ''
long_description: ''
flags: []
subcommands: []
parent: null
run_function: null
file_path: /app/plandex/app/cli/cmd/update.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
usage:
name: usage
use: usage
aliases: []
short_description: Display credits balance and usage report
long_description: ''
flags:
- name: page-size
shorthand: s
flag_type: int
default_value: 100
description: Number of transactions to display per page
required: false
global_flag: false
- name: page
shorthand: p
flag_type: int
default_value: 1
description: Page number to display
required: false
global_flag: false
subcommands: []
parent: null
run_function: usage
file_path: /app/plandex/app/cli/cmd/usage.go
requires_auth: true
requires_project: true
requires_plan: true
hidden: false
users:
name: users
use: users
aliases: []
short_description: List all users and pending invites and the current org
long_description: ''
flags: []
subcommands: []
parent: null
run_function: listUsersAndInvites
file_path: /app/plandex/app/cli/cmd/users.go
requires_auth: true
requires_project: false
requires_plan: false
hidden: false
version:
name: version
use: version
aliases: []
short_description: Print the version number of Plandex
long_description: All software has versions. This is Plandex's
flags: []
subcommands: []
parent: null
run_function: func
file_path: /app/plandex/app/cli/cmd/version.go
requires_auth: false
requires_project: false
requires_plan: false
hidden: false
hierarchy:
root:
subcommands:
- connect-claude
- disconnect-claude
metadata:
repl_commands: []
shortcuts: {}
environment_variables: []
configuration_options: []
statistics:
total_commands: 67
commands_with_aliases: 0
commands_with_flags: 17
total_flags: 24
hidden_commands: 0
auth_required: 64
project_required: 44
plan_required: 45