Skip to content

DOCUMENTATION.md

Latest commit

 

History

History
124 lines (96 loc) · 3.34 KB

DOCUMENTATION.md

File metadata and controls

124 lines (96 loc) · 3.34 KB

aeckit-cli Command Reference

The aeckit CLI is built around a resource-oriented architecture. The primary resources are companies, projects, and workflows.

By default, the CLI looks for data in a local companies/ directory, but this can be overridden with the --base-path flag.

1. Configuration (config)

Manage your active working context to avoid passing --company and --project flags on every command.

Set active context

Creates or updates a local .aeckit JSON file in your current directory.

aeckit config set --company acme-corp --project building-a

Show current context

Prints the current configuration state.

aeckit config show
# Output:
# {
#   "company": "acme-corp",
#   "project": "building-a"
# }

2. Companies (company)

Manage architectural/engineering company portfolios.

Create a company

Creates a new directory for the company.

aeckit company create --name acme-corp

List all companies

Scans the base path and lists all company directories.

aeckit company list

3. Projects (project)

Manage building projects and their Single Source of Truth (project.json).

Create a project

Automatically scaffolds the project folder, history/reports directories, an empty project.json, and an empty workflow.json.

aeckit project create --name building-a
# Or explicitly: aeckit project create --name building-a --company acme-corp

List projects

Lists all projects belonging to the active (or specified) company.

aeckit project list

Show project data

Prints the loaded state of the project's project.json (the Single Source of Truth).

aeckit project show

4. Workflows (workflow)

Manage and inspect the engineering workflows defined in workflow.json.

List workflows

Shows all available workflow names for the active project.

aeckit workflow list

Show workflow steps

Shows the exact ordered list of Python scripts that make up a specific workflow.

aeckit workflow show --workflow default_workflow

5. Execution (flow)

The core orchestrator command. Runs a sequence of Python scripts against your project data.

Run a workflow

Executes the workflow, automatically saving mutations back to project.json.

aeckit flow default_workflow

Dry Run

Executes the workflow and prints output to the terminal, but skips saving changes to project.json.

aeckit flow default_workflow --dry-run

Snapshot Run

Automatically creates a timestamped backup of your project.json in the history/ directory before running the workflow.

aeckit flow default_workflow --snapshot

Run with explicit context

You can run a workflow without relying on a local config file by passing the context flags inline:

aeckit flow default_workflow --company acme-corp --project building-a

Global Flags

Almost all commands support the following global flags to override defaults:

  • --company <id>: Override the company context.
  • --project <id>: Override the project context.
  • --base-path <path>: Tell the CLI to look for data in a different root directory (Default: companies).
  • --scripts-dir <path>: Tell the CLI where to find your Python engineering rules (Default: scripts). Used primarily with the flow command.