Skip to content

civic-interconnect/civic-dev

Repository files navigation

civic-dev (Command Line Interface)

Version License: MIT Build Nightly Zig Check

A Command Line Interface (CLI) toolkit for Civic Interconnect projects.

Quick Start

  1. Download the latest civic-dev executable from the Releases page.
  2. Extract the archive.
  3. Include the executable file in your Path.

For example, on Windows, put the executable in C:\Users<username>\AppData\Local\Microsoft\WindowsApps.

Use the civic-dev CLI

Use the civic-dev CLI while working on Civic Interconnect projects:

civic-dev [command] [options...]

Examples:

civic-dev layout
civic-dev check-policy

Available Commands

Command Description Arguments / Flags
civic-dev setup-py Set up Python environment (install dependencies). (none)
civic-dev start-py Start Python environment (e.g. run dev tools). (none)
civic-dev sync-files Sync shared Civic Interconnect files into repo. --root, `--project [py
civic-dev layout Show project layout information. (none)
civic-dev check-policy Check repo files against project policy. (none)
civic-dev run Auto-detect and run the appropriate environment. (none)
civic-dev bump-version Update version numbers in files. OLD_VERSION NEW_VERSION (required)
civic-dev release Run release process for repo. (none)

CLI Development

See DEVELOPER.md