CLI commands
arc capsule
Move an Arc project without Git or workspace file contents
CLI reference index · CLI behavior guide
arc capsule
Move an Arc project without Git or workspace file contents
usage: arc capsule [-h] {export,inspect,import,sync} ...
positional arguments:
{export,inspect,import,sync}
export Save a share-safe portable .arcpack capsule
inspect validate and summarize a capsule without importing,
with a scan for keys, this hub's operator key and
email addresses
import transactionally import a capsule: continue the local
project with its lineage, or create one
sync keep a folder of capsules in Git in step with this
hub: import, then refresh, the capsules of projects
this hub holds, or --pull to only import them; never
runs git
options:
-h, --help show this help message and exit
Argument defaults
| Argument | Required | Default | Choices |
|---|
arc capsule export
Save a share-safe portable .arcpack capsule
usage: arc capsule export [-h] [--out OUT] [--all] [--out-dir OUT_DIR]
[--project PROJECT]
[--scope {knowledge,complete,selected_rooms}]
[--rooms ROOMS]
[--privacy {share_safe,full_history}]
[--redact-emails] [--git-mirror] [--yes] [--verbose]
[--base-url BASE_URL]
[project]
positional arguments:
project project_id, slug or name (omit with --all)
options:
-h, --help show this help message and exit
--out OUT destination .arcpack path (never overwritten)
--all export every active project into --out-dir, one
<slug>-<id8>.arcpack each plus manifest.json; system
projects are skipped
--out-dir OUT_DIR empty folder for --all (created if missing)
--project PROJECT with --all, export only this project (repeatable)
--scope {knowledge,complete,selected_rooms}
--rooms ROOMS comma-separated room ids for --scope selected_rooms
--privacy {share_safe,full_history}
--redact-emails also remove email addresses (share_safe only)
--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;
without it and without a terminal, the prompt is
printed and the command exits 2
--verbose with --yes, echo each accepted prompt to stderr
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
project | no | null | — |
--out | no | null | — |
--all | no | false | — |
--out-dir | no | null | — |
--project | no | null | — |
--scope | no | "complete" | ['knowledge', 'complete', 'selected_rooms'] |
--rooms | no | null | — |
--privacy | no | "share_safe" | ['share_safe', 'full_history'] |
--redact-emails | no | false | — |
--git-mirror | no | false | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc capsule inspect
validate and summarize a capsule without importing, with a scan for keys, this hub's operator key and email addresses
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
| Argument | Required | Default | Choices |
|---|---|---|---|
path | yes | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc capsule import
transactionally import a capsule: continue the local project with its lineage, or create one
usage: arc capsule import [-h] [--dir DIR] [--replace] [--force] [--as-new]
[--yes] [--verbose] [--base-url BASE_URL]
[path]
positional arguments:
path the .arcpack file (omit with --dir)
options:
-h, --help show this help message and exit
--dir DIR import every capsule in this folder, in manifest.json
order when present, else by file name; one failure
stops nothing
--replace take the capsule's copy instead of continuing: archive
the local project with the same lineage and give the
import its slug
--force with --replace, replace even when the local copy has
work the capsule lacks
--as-new import a separate copy with a lineage of its own, even
when this hub already has the project
--yes, -y accept the daemon's exact import confirmation prompt;
without it and without a terminal, the prompt is
printed and the command exits 2
--verbose with --yes, echo each accepted prompt to stderr
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
path | no | null | — |
--dir | no | null | — |
--replace | no | false | — |
--force | no | false | — |
--as-new | no | false | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc capsule sync
keep a folder of capsules in Git in step with this hub: import, then refresh, the capsules of projects this hub holds, or --pull to only import them; never runs git
usage: arc capsule sync [-h] [--product PRODUCT] [--project PROJECT] [--pull]
[--accept-new SLUG] [--accept-all-new] [--yes]
[--verbose] [--base-url BASE_URL]
dir
positional arguments:
dir a minds folder (manifest.json, one subfolder per
product), a folder from export --all, or a new folder
options:
-h, --help show this help message and exit
--product PRODUCT only this product's subfolder; new capsules go to
<product>/<slug>.arcpack (default arc)
--project PROJECT also keep this project (id, slug or name) in the folder
(repeatable)
--pull import the folder's capsules: each continues its
project here; projects new to this hub only with
--accept-new
--accept-new SLUG with --pull, also import this new project (repeatable)
--accept-all-new with --pull, import every project new to this hub
--yes, -y accept the daemon's export or import confirmation for
each capsule; without it and without a terminal, the
first prompt is printed and the command exits 2
--verbose with --yes, echo each accepted prompt to stderr
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
dir | yes | null | — |
--product | no | null | — |
--project | no | null | — |
--pull | no | false | — |
--accept-new | no | null | — |
--accept-all-new | no | false | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |