Command-line interface for the AcuGIS geospatial platform
Project description
ACUGIS CLI
Command-line interface for the AcuGIS geospatial platform. Manage datasets, maps, dashboards, reports, databases, ETL pipelines, and synchronization projects from the terminal.
Authentication uses Central username/password login and persists the shared acugis_session cookie — the same model as the browser.
Installation
Development install
cd cli
python3 -m venv .venv
# Linux / macOS
source .venv/bin/activate
# Windows
.venv\Scripts\activate
pip install -e .
This installs the acugis command into your virtual environment.
Verify
acugis version
acugis --help
Quick start
acugis login https://app.acugis.cloud
acugis whoami
acugis catalog
acugis datasets list
acugis datasets preview bees
Configuration
Login writes local session files under ~/.config/acugis/:
| File | Purpose |
|---|---|
config.json |
Platform base URL |
cookies.txt |
Central session cookies (acugis_session) |
Example config.json:
{
"base_url": "https://app.acugis.cloud"
}
Session cookies are reused across CLI restarts until they expire or you run acugis logout.
Shell completion
Typer provides shell completion for Bash, Zsh, Fish, and PowerShell.
Install completion for your shell:
acugis --install-completion
Show the completion script without installing:
acugis --show-completion
Restart your shell after installing completion.
Command reference
Authentication
| Command | Description |
|---|---|
acugis login <url> |
Log in with Central username and password |
acugis logout |
Remove local config and session cookies |
acugis whoami |
Show the current authenticated user |
acugis login https://app.acugis.cloud
acugis whoami
acugis whoami --json
acugis logout
Catalog
| Command | Description |
|---|---|
acugis catalog |
List datasets, maps, dashboards, and reports |
acugis catalog
acugis catalog --json
Datasets (Geovault)
| Command | Description |
|---|---|
acugis datasets list |
List datasets from the platform catalog |
acugis datasets preview <name> |
Preview dataset records (GeoJSON) |
acugis datasets info |
Show dataset metadata (placeholder) |
acugis datasets upload |
Upload a dataset (placeholder) |
acugis datasets download |
Download a dataset (placeholder) |
acugis datasets publish |
Publish a dataset (placeholder) |
acugis datasets versions |
List dataset versions (placeholder) |
acugis datasets list
acugis datasets list --json
acugis datasets preview bees
acugis datasets preview bees --version 2
acugis datasets preview bees --json
Maps (QGIS Publish Service)
| Command | Description |
|---|---|
acugis maps list |
List published maps from the platform catalog |
acugis maps info <map> |
Show map metadata (layers, reports, versions) |
acugis maps open <map> |
Open the map viewer URL in a browser |
acugis maps versions <map> |
List map versions/snapshots |
acugis maps publish |
Publish a map (placeholder) |
acugis maps delete |
Delete a map (placeholder) |
acugis maps list
acugis maps list --json
acugis maps info nyc
acugis maps open nyc
acugis maps versions nyc
Dashboards (Dashboard Service)
| Command | Description |
|---|---|
acugis dashboards list |
List dashboards (placeholder) |
acugis dashboards open |
Open a dashboard (placeholder) |
acugis dashboards publish |
Publish a dashboard (placeholder) |
Reports (Jasper)
| Command | Description |
|---|---|
acugis reports list |
List reports (placeholder) |
acugis reports run |
Run a report (placeholder) |
acugis reports schedule |
Schedule a report (placeholder) |
acugis reports info |
Show report metadata (placeholder) |
Databases (PostGIS Service)
| Command | Description |
|---|---|
acugis db list |
List databases (placeholder) |
acugis db create |
Create a database (placeholder) |
acugis db clone |
Clone a database (placeholder) |
acugis db backup |
Back up a database (placeholder) |
acugis db restore |
Restore a database (placeholder) |
acugis db delete |
Delete a database (placeholder) |
GeoETL
| Command | Description |
|---|---|
acugis etl pipelines |
List ETL pipelines (placeholder) |
acugis etl run |
Run an ETL pipeline (placeholder) |
acugis etl import |
Import data via ETL (placeholder) |
acugis etl status |
Show ETL job status (placeholder) |
Sync (GeoSync)
| Command | Description |
|---|---|
acugis sync projects |
List sync projects (placeholder) |
acugis sync servers |
List sync servers (placeholder) |
acugis sync status |
Show sync status (placeholder) |
acugis sync publish |
Publish a sync project (placeholder) |
Version
acugis version
JSON output
Commands that return data support --json for machine-readable output:
acugis whoami --json
acugis catalog --json
acugis datasets list --json
acugis datasets preview bees --json
acugis maps list --json
acugis maps info nyc --json
Project layout
acugis/
cli.py Main application entry point
auth.py Login, logout, whoami
catalog.py Platform catalog
session.py Config, cookies, HTTP helpers
util.py Output formatting
services/ Per-service command groups
pyproject.toml Package metadata and entry points
README.md
LICENSE
License
MIT — see LICENSE.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file acugis-0.2.0.tar.gz.
File metadata
- Download URL: acugis-0.2.0.tar.gz
- Upload date:
- Size: 52.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
94a985b5a55e8eaec819366b31a48041c2899ef046f1398625b48825ec3f027d
|
|
| MD5 |
2c26261da38e79bcc6790f34627618a9
|
|
| BLAKE2b-256 |
1c51e7916ec626369c06a68262ea625a30826155d3b86b32c585f7af5c2980a7
|
File details
Details for the file acugis-0.2.0-py3-none-any.whl.
File metadata
- Download URL: acugis-0.2.0-py3-none-any.whl
- Upload date:
- Size: 59.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.12.3
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1e4dbc4b2a8293429504779a9aa46563e6a6eeb69c24f9e97d24f8b13b296fe4
|
|
| MD5 |
cfaa05717569da8b0b1fa07eac6c5295
|
|
| BLAKE2b-256 |
b039a6abc163b655ce2aa45f1548f35ee58f323f359a2c996ec4310169e542f1
|