Arcsecond CLI

The Command-line interface (CLI) for Arcsecond. It can be used as Python module too. The CLI makes it easy to login/register and access Arcsecond resources, public and private ones.

Read the docs

Running Arcsecond.local

The CLI owns the whole lifecycle of a self-hosted installation; there is no docker command to type:

$ arcsecond setup --lan-host 192.168.1.42   # writes .env and docker-compose.yml
$ arcsecond start                           # first run downloads the images
$ arcsecond status
$ arcsecond logs backend -f
$ arcsecond restart backend worker          # after editing .env
$ arcsecond update                          # newer images, refreshed compose file
$ arcsecond stop

Every one of these finds the installation in the current folder, or in the folder arcsecond setup last ran in, or where --dir points.

Which server the CLI talks to

The CLI points at one API server at a time — the cloud by default, or a server you registered, typically your own Arcsecond.local — and every command follows that pointer:

$ arcsecond api                     # list them, * marks the current one
$ arcsecond api use local           # `setup` registered `local` for you
$ arcsecond login                   # on that server

Credentials are kept per server. For a script or a cron job, ARCSECOND_API=<name> selects a server for that process alone, without moving the pointer.

Configuration

Credentials and settings live in ~/.config/arcsecond/, alongside the list of registered cameras and the live-image proxy's runtime files.

Set ARCSECOND_CONFIG_DIR to put them somewhere else:

$ ARCSECOND_CONFIG_DIR=~/.config/arcsecond-observatory arcsecond login

Useful for keeping a personal account and an observatory's apart, and for containers or CI jobs that should not touch a home directory. Child processes the CLI starts — such as the background proxy from arcsecond proxy start — inherit it.

Development

The project uses uv for environment and dependency management. After forking and cloning:

$ cd ~/arcsecond-cli
$ uv sync --extra webcam --group dev
$ uv run arcsecond --help
$ uv run pytest

uv sync creates .venv/ and installs the project with its webcam extra and the dev dependency group (pytest, black, flake8, isort). Prefix commands with uv run or activate the venv with source .venv/bin/activate.

The test suite writes nothing to your own configuration: an autouse fixture in tests/conftest.py points ARCSECOND_CONFIG_DIR at a temporary directory for the whole run. Several tests save real-looking credentials, so if you add one that touches ArcsecondConfig, leave that fixture in place.

License

Release files for arcsecond 4.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for arcsecond 4.1.0
File	Size	Uploaded
arcsecond-4.1.0.tar.gz	742.3 kB	Sep 22, 2026	Details

Built distribution (wheel)

Table of built distributions (wheels) for arcsecond 4.1.0
File	Interpreter	ABI	Platform	Reset
arcsecond-4.1.0-py3-none-any.whl 150.5 kB Sep 22, 2026	Python 3	none	any	Details

Total release size: 892.8 kB

Release files / arcsecond-4.1.0.tar.gz

Download URL	arcsecond-4.1.0.tar.gz
Size	742.3 kB
Tags	Source
SHA-256 checksum How to use checksums	`2f2b8a7e633afd1f7ca913cd225baba31a14392514e793dc2c8876dbe87d5abb`
BLAKE2b-256 checksum How to use checksums	`815eafed146754f5a307d4ce06b313720d516d80fd470f4e371ff9f3ce1eef1e`
Upload date	Sep 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/arcsecond-io/cli
Publishing commit: github.com/arcsecond-io/cli/tree/d90922cfc92fe8d31bc830c3bdb59e61866189d8

Workflow

Publishing configuration: github.com/arcsecond-io/cli/blob/d90922cfc92fe8d31bc830c3bdb59e61866189d8/.github/workflows/pythonpublish.yml
Publishing logs: github.com/arcsecond-io/cli/actions/runs/35761319279/attempts/1

Artifact

Subject: arcsecond-4.1.0.tar.gz
SHA-256 checksum: 2f2b8a7e633afd1f7ca913cd225baba31a14392514e793dc2c8876dbe87d5abb Verifying attestations

Release files / arcsecond-4.1.0-py3-none-any.whl

Download URL	arcsecond-4.1.0-py3-none-any.whl
Size	150.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`2df57dcff2d53d6d6f525c4d68a52622d6694b0f749213eee317d8ae45cd0d7f`
BLAKE2b-256 checksum How to use checksums	`93a3cd43963d1e1f074de38585bc8ac3b3a9294b457767011e4a434e9f3ae29d`
Upload date	Sep 22, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	Yes
Uploaded via	`twine/7.0.0 CPython/3.13.14`

Provenance

Identity

Publishing platform: GitHub Actions
Publishing repository: github.com/arcsecond-io/cli
Publishing commit: github.com/arcsecond-io/cli/tree/d90922cfc92fe8d31bc830c3bdb59e61866189d8

Workflow

Publishing configuration: github.com/arcsecond-io/cli/blob/d90922cfc92fe8d31bc830c3bdb59e61866189d8/.github/workflows/pythonpublish.yml
Publishing logs: github.com/arcsecond-io/cli/actions/runs/35761319279/attempts/1

Artifact

Subject: arcsecond-4.1.0-py3-none-any.whl
SHA-256 checksum: 2df57dcff2d53d6d6f525c4d68a52622d6694b0f749213eee317d8ae45cd0d7f Verifying attestations