Skip to content

AGENTS.md

Latest commit

 

History

History
34 lines (18 loc) · 1.37 KB

AGENTS.md

File metadata and controls

34 lines (18 loc) · 1.37 KB

Synkronus CLI — AI & developer guide

When to use this doc: You are changing the synk command-line tool (Go) or its packaging.

See also: ../AGENTS.md.

User-facing docs: Synkronus CLI on opendataensemble.org.

What this package is

  • synkronus-cli provides synk — scriptable access to the same Synkronus HTTP API as Portal and Formulus: login, sync, app bundle upload/download, export (e.g. Parquet), config.

Layout

  • Entry: cmd/synkronus/ (or as structured in this repo — see README.md).
  • Config: ~/.synkronus.yaml by default; synk config use for multiple profiles (see README.md).

License note

The CLI may be GPL-2.0-or-later until the QR dependency cleanup described in the root README.md and FOLLOWUP-custom-qrcode-writer.md. Do not change license without maintainer intent.

Install / build

From README.md: go install, release binaries from GitHub, or ghcr.io/opendataensemble/synkronus-cli. Installation scripts: scripts/install-synkronus-cli.sh.

CI login: synk login -u USER --password "$SYNK_PASSWORD" (or SYNK_PASSWORD env when stdin is not a TTY).