CLI commands
arc arcmind
Arcmind: share status, claims and records with colleagues through an arc/arcmind branch
On this page
CLI reference index · CLI behavior guide
arc arcmind
Arcmind: share status, claims and records with colleagues through an arc/arcmind branch
usage: arc arcmind [-h]
{enable,preview,repoint,status,sync,disable,settings,confirm-private,share,ask,answer} ...
positional arguments:
{enable,preview,repoint,status,sync,disable,settings,confirm-private,share,ask,answer}
enable preview, approve and bind a destination
preview show the exact bytes Arc would push first, or the
current snapshot
repoint leave this destination and bind another
status destination, outbox, colleagues and the last error
sync ask for an immediate round trip (clears a stopped
error)
disable stop sharing
settings show or change the publishing rooms and snapshot field
groups while sharing
confirm-private vouch that a destination Arc cannot verify is private
share share a note, decision, handoff or retraction
ask ask colleagues a question
answer answer a colleague's ask
options:
-h, --help show this help message and exit
Argument defaults
| Argument | Required | Default | Choices |
|---|
arc arcmind enable
preview, approve and bind a destination
usage: arc arcmind enable [-h] [--remote REMOTE] [--repo REPO]
[--handle HANDLE] [--display-name DISPLAY_NAME]
[--person PERSON_ID] [--room ROOMS]
[--field-off {branch,subjects,tasks,locked_paths,claims}]
[--project PROJECT] [--yes] [--verbose]
[--base-url BASE_URL]
options:
-h, --help show this help message and exit
--remote REMOTE remote name or URL (default: origin)
--repo REPO the checkout folder (default: the bound one)
--handle HANDLE
--display-name DISPLAY_NAME
--person PERSON_ID link to your person id from another hub
--room ROOMS a publishing room (repeat; default: the rooms whose
folder is in the checkout)
--field-off {branch,subjects,tasks,locked_paths,claims}
leave a snapshot field group out (repeat)
--project PROJECT project id, slug or name (default: the project bound
to this folder)
--yes, -y accept the daemon's exact 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 |
|---|---|---|---|
--remote | no | null | — |
--repo | no | null | — |
--handle | no | null | — |
--display-name | no | null | — |
--person | no | null | — |
--room | no | null | — |
--field-off | no | null | ['branch', 'subjects', 'tasks', 'locked_paths', 'claims'] |
--project | no | null | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind preview
show the exact bytes Arc would push first, or the current snapshot
usage: arc arcmind preview [-h] [--remote REMOTE] [--repo REPO]
[--handle HANDLE] [--display-name DISPLAY_NAME]
[--person PERSON_ID] [--room ROOMS]
[--field-off {branch,subjects,tasks,locked_paths,claims}]
[--project PROJECT] [--yes] [--verbose]
[--base-url BASE_URL]
options:
-h, --help show this help message and exit
--remote REMOTE remote name or URL (default: origin)
--repo REPO the checkout folder (default: the bound one)
--handle HANDLE
--display-name DISPLAY_NAME
--person PERSON_ID link to your person id from another hub
--room ROOMS a publishing room (repeat; default: the rooms whose
folder is in the checkout)
--field-off {branch,subjects,tasks,locked_paths,claims}
leave a snapshot field group out (repeat)
--project PROJECT project id, slug or name (default: the project bound
to this folder)
--yes, -y accept the daemon's exact 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 |
|---|---|---|---|
--remote | no | null | — |
--repo | no | null | — |
--handle | no | null | — |
--display-name | no | null | — |
--person | no | null | — |
--room | no | null | — |
--field-off | no | null | ['branch', 'subjects', 'tasks', 'locked_paths', 'claims'] |
--project | no | null | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind repoint
leave this destination and bind another
usage: arc arcmind repoint [-h] [--remote REMOTE] [--repo REPO]
[--handle HANDLE] [--display-name DISPLAY_NAME]
[--person PERSON_ID] [--room ROOMS]
[--field-off {branch,subjects,tasks,locked_paths,claims}]
[--offline] [--project PROJECT] [--yes] [--verbose]
[--base-url BASE_URL]
options:
-h, --help show this help message and exit
--remote REMOTE remote name or URL (default: origin)
--repo REPO the checkout folder (default: the bound one)
--handle HANDLE
--display-name DISPLAY_NAME
--person PERSON_ID link to your person id from another hub
--room ROOMS a publishing room (repeat; default: the rooms whose
folder is in the checkout)
--field-off {branch,subjects,tasks,locked_paths,claims}
leave a snapshot field group out (repeat)
--offline skip the leave update
--project PROJECT project id, slug or name (default: the project bound
to this folder)
--yes, -y accept the daemon's exact 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 |
|---|---|---|---|
--remote | no | null | — |
--repo | no | null | — |
--handle | no | null | — |
--display-name | no | null | — |
--person | no | null | — |
--room | no | null | — |
--field-off | no | null | ['branch', 'subjects', 'tasks', 'locked_paths', 'claims'] |
--offline | no | false | — |
--project | no | null | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind status
destination, outbox, colleagues and the last error
usage: arc arcmind status [-h] [--project PROJECT] [--base-url BASE_URL]
options:
-h, --help show this help message and exit
--project PROJECT project id, slug or name (default: the project bound to
this folder)
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
--project | no | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind sync
ask for an immediate round trip (clears a stopped error)
usage: arc arcmind sync [-h] [--follow] [--recreate] [--dismiss ALERT_ID]
[--project PROJECT] [--base-url BASE_URL]
options:
-h, --help show this help message and exit
--follow after a rewrite or deletion, accept the branch's
current tip once it validates
--recreate after a deletion, create the branch again
--dismiss ALERT_ID clear an alert status lists, such as a share that may
have been published at a previous destination (repeat)
--project PROJECT project id, slug or name (default: the project bound to
this folder)
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
--follow | no | false | — |
--recreate | no | false | — |
--dismiss | no | null | — |
--project | no | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind disable
stop sharing
usage: arc arcmind disable [-h] [--offline] [--project PROJECT] [--yes]
[--verbose] [--base-url BASE_URL]
options:
-h, --help show this help message and exit
--offline skip the leave update
--project PROJECT project id, slug or name (default: the project bound to
this folder)
--yes, -y accept the daemon's exact 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 |
|---|---|---|---|
--offline | no | false | — |
--project | no | null | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind settings
show or change the publishing rooms and snapshot field groups while sharing
usage: arc arcmind settings [-h] [--room ROOMS] [--add-room ADD_ROOMS]
[--remove-room REMOVE_ROOMS]
[--field-on {branch,subjects,tasks,locked_paths,claims}]
[--field-off {branch,subjects,tasks,locked_paths,claims}]
[--project PROJECT] [--yes] [--verbose]
[--base-url BASE_URL]
options:
-h, --help show this help message and exit
--room ROOMS the publishing rooms, as a whole list (repeat)
--add-room ADD_ROOMS add a publishing room (repeat)
--remove-room REMOVE_ROOMS
stop publishing from a room (repeat)
--field-on {branch,subjects,tasks,locked_paths,claims}
share a snapshot field group (repeat)
--field-off {branch,subjects,tasks,locked_paths,claims}
leave a snapshot field group out (repeat)
--project PROJECT project id, slug or name (default: the project bound
to this folder)
--yes, -y accept the daemon's exact 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 |
|---|---|---|---|
--room | no | null | — |
--add-room | no | null | — |
--remove-room | no | null | — |
--field-on | no | null | ['branch', 'subjects', 'tasks', 'locked_paths', 'claims'] |
--field-off | no | null | ['branch', 'subjects', 'tasks', 'locked_paths', 'claims'] |
--project | no | null | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind confirm-private
vouch that a destination Arc cannot verify is private
usage: arc arcmind confirm-private [-h] [--project PROJECT] [--yes]
[--verbose] [--base-url BASE_URL]
options:
-h, --help show this help message and exit
--project PROJECT project id, slug or name (default: the project bound to
this folder)
--yes, -y accept the daemon's exact 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 | — |
--yes, -y | no | false | — |
--verbose | no | false | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind share
share a note, decision, handoff or retraction
usage: arc arcmind share [-h] [--kind {note,decision,handoff,retract}]
[--title TITLE] [--target TARGET] [--body BODY]
[--path PATHS] [--branch BRANCH] [--commit COMMIT]
[--project PROJECT] [--room ROOM]
[--base-url BASE_URL]
options:
-h, --help show this help message and exit
--kind {note,decision,handoff,retract}
--title TITLE
--target TARGET the <writer>/<seq> a retract names
--body BODY
--path PATHS a repository path ref
--branch BRANCH
--commit COMMIT
--project PROJECT
--room ROOM publishing room (default: the room bound to this
folder)
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
--kind | no | "note" | ['note', 'decision', 'handoff', 'retract'] |
--title | no | null | — |
--target | no | null | — |
--body | no | null | — |
--path | no | null | — |
--branch | no | null | — |
--commit | no | null | — |
--project | no | null | — |
--room | no | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind ask
ask colleagues a question
usage: arc arcmind ask [-h] [--to TO] [--body BODY] [--path PATHS]
[--branch BRANCH] [--commit COMMIT] [--project PROJECT]
[--room ROOM] [--base-url BASE_URL]
options:
-h, --help show this help message and exit
--to TO a person or writer id
--body BODY
--path PATHS a repository path ref
--branch BRANCH
--commit COMMIT
--project PROJECT
--room ROOM publishing room (default: the room bound to this
folder)
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
--to | no | null | — |
--body | no | null | — |
--path | no | null | — |
--branch | no | null | — |
--commit | no | null | — |
--project | no | null | — |
--room | no | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |
arc arcmind answer
answer a colleague's ask
usage: arc arcmind answer [-h] [--body BODY] [--path PATHS] [--branch BRANCH]
[--commit COMMIT] [--project PROJECT] [--room ROOM]
[--base-url BASE_URL]
key
positional arguments:
key the ask's <writer>/<seq>
options:
-h, --help show this help message and exit
--body BODY
--path PATHS a repository path ref
--branch BRANCH
--commit COMMIT
--project PROJECT
--room ROOM publishing room (default: the room bound to this
folder)
--base-url BASE_URL
Argument defaults
| Argument | Required | Default | Choices |
|---|---|---|---|
key | yes | null | — |
--body | no | null | — |
--path | no | null | — |
--branch | no | null | — |
--commit | no | null | — |
--project | no | null | — |
--room | no | null | — |
--base-url | no | "http://127.0.0.1:6969" | — |