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

CLI commands

arc ensure

Start hub if not already running, then exit

CLI reference index · CLI behavior guide

arc ensure

Start hub if not already running, then exit

text
usage: arc ensure [-h] [--host HOST] [--port PORT] [--storage STORAGE]
                  [--spool-dir SPOOL_DIR] [--timeout TIMEOUT] [--allow-remote]
                  [--max-body-chars MAX_BODY_CHARS]
                  [--max-attachment-chars MAX_ATTACHMENT_CHARS]
                  [--max-attachments MAX_ATTACHMENTS]

options:
  -h, --help            show this help message and exit
  --host HOST
  --port PORT
  --storage STORAGE     SQLite path. Defaults to <arc data-root>/app.db; pass
                        an explicit path to keep cwd-relative storage.
  --spool-dir SPOOL_DIR
  --timeout TIMEOUT
  --allow-remote
  --max-body-chars MAX_BODY_CHARS
                        Maximum characters in a message body
  --max-attachment-chars MAX_ATTACHMENT_CHARS
                        Maximum characters per attachment (JSON-encoded)
  --max-attachments MAX_ATTACHMENTS
                        Maximum attachments per message

Argument defaults

ArgumentRequiredDefaultChoices
--hostno"127.0.0.1"
--portno6969
--storagenonull
--spool-dirno".arc-relay"
--timeoutno60.0
--allow-remotenofalse
--max-body-charsno128000
--max-attachment-charsno256000
--max-attachmentsno32