Skip to content
ARC / Agent documentation
Agent index ↗Back to Arc ↗

CLI commands

arc capsule

Move an Arc project without Git or workspace file contents

On this page

CLI reference index · CLI behavior guide

arc capsule

Move an Arc project without Git or workspace file contents

text
usage: arc capsule [-h] {export,inspect,import} ...

positional arguments:
  {export,inspect,import}
    export              Save a share-safe portable .arcpack capsule
    inspect             validate and summarize a capsule without importing
    import              transactionally import a capsule as a new project

options:
  -h, --help            show this help message and exit

Argument defaults

ArgumentRequiredDefaultChoices

arc capsule export

Save a share-safe portable .arcpack capsule

text
usage: arc capsule export [-h] --out OUT
                          [--scope {knowledge,complete,selected_rooms}]
                          [--rooms ROOMS]
                          [--privacy {share_safe,full_history}] [--git-mirror]
                          [--yes] [--base-url BASE_URL]
                          project

positional arguments:
  project               project_id or slug

options:
  -h, --help            show this help message and exit
  --out OUT             destination .arcpack path (never overwritten)
  --scope {knowledge,complete,selected_rooms}
  --rooms ROOMS         comma-separated room ids for --scope selected_rooms
  --privacy {share_safe,full_history}
  --git-mirror          also write a readable .arc mirror when one bound Git
                        workspace already exists; never installs, stages,
                        commits, or pushes Git
  --yes, -y             accept the daemon's exact export confirmation prompt
  --base-url BASE_URL

Argument defaults

ArgumentRequiredDefaultChoices
projectyesnull
--outyesnull
--scopeno"knowledge"['knowledge', 'complete', 'selected_rooms']
--roomsnonull
--privacyno"share_safe"['share_safe', 'full_history']
--git-mirrornofalse
--yes, -ynofalse
--base-urlno"http://127.0.0.1:6969"

arc capsule inspect

validate and summarize a capsule without importing

text
usage: arc capsule inspect [-h] [--base-url BASE_URL] path

positional arguments:
  path

options:
  -h, --help           show this help message and exit
  --base-url BASE_URL

Argument defaults

ArgumentRequiredDefaultChoices
pathyesnull
--base-urlno"http://127.0.0.1:6969"

arc capsule import

transactionally import a capsule as a new project

text
usage: arc capsule import [-h] [--yes] [--base-url BASE_URL] path

positional arguments:
  path

options:
  -h, --help           show this help message and exit
  --yes, -y            accept the daemon's exact import confirmation prompt
  --base-url BASE_URL

Argument defaults

ArgumentRequiredDefaultChoices
pathyesnull
--yes, -ynofalse
--base-urlno"http://127.0.0.1:6969"