Arcsecond CLI
The Arcsecond CLI is the open-source companion that connects to and interacts with an Arcsecond API server — whether that is the cloud or your own Arcsecond.local install. Its main purpose today is precisely this: to set up and run Arcsecond.local.
It is a lightweight command-line tool and a Python module, giving you two entry points:
- the
arcsecondcommand-line tool for day-to-day operations - the
arcsecondPython module for automation and integration
The CLI works like a tool such as git: arcsecond is the main entry point, followed by a command. Many commands map directly to Arcsecond resources.
Quick Start
pip install arcsecond
arcsecond --helpSetting up & running Arcsecond.local
The arcsecond command is how you install, operate and maintain a self-hosted install. The core flow is documented in the Arcsecond.local section:
- Installation —
arcsecond setup, thenarcsecond start. - Updates —
arcsecond updatemoves to the latest release. - Day to day:
arcsecond status,arcsecond logs,arcsecond stop,arcsecond restart— every command and its options is in the command reference, generated from the tool itself. - Live-Image Proxy — stream USB webcams, all-sky cameras and network cameras into Arcsecond.local.
- Backups — list, inspect, and restore the Postgres dumps.
- Rotate Postgres Password — rotate the database password on an existing install.
Connecting to a server
The CLI talks to one server at a time — the cloud by default, or your own install once you point it there with arcsecond api use local — and the same commands work against either:
- Install & Login — install the package and authenticate.
- Installing on Windows — Windows-specific setup and
PATHtroubleshooting. - Data Upload — upload datasets and all-sky images from the CLI or Python.
- Python API — Basics — reuse your credentials in code (use
subdomain="local"for a self-hosted install). - Python API — Resources — generic CRUD helpers and target workflows.