Metadata-Version: 2.4
Name: crewplane
Version: 0.1.0a1
Summary: A CLI orchestrator for AI agents
Project-URL: Homepage, https://github.com/crewplaneai/crewplane
Project-URL: Repository, https://github.com/crewplaneai/crewplane
Project-URL: Issues, https://github.com/crewplaneai/crewplane/issues
Project-URL: Documentation, https://github.com/crewplaneai/crewplane/blob/main/docs/index.md
License-Expression: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.13
Requires-Dist: click>=8.0.0
Requires-Dist: markdown-it-py>=4.0
Requires-Dist: pydantic>=2.0
Requires-Dist: pyyaml>=6.0
Requires-Dist: rich>=13.0
Requires-Dist: shellingham>=1.3.0
Requires-Dist: typer>=0.12.0
Requires-Dist: tzdata; platform_system == 'Windows'
Provides-Extra: dev
Requires-Dist: build>=1.3; extra == 'dev'
Requires-Dist: packaging>=24.0; extra == 'dev'
Requires-Dist: pytest>=7.4; extra == 'dev'
Requires-Dist: ruff>=0.6; extra == 'dev'
Requires-Dist: twine>=6.0; extra == 'dev'
Description-Content-Type: text/markdown

# Crewplane / Orchestrator CLI

Crewplane runs AI coding CLIs through auditable Markdown workflows.

Define a DAG in a `.task.md` file, assign nodes to providers such as Claude,
Codex, Gemini, Copilot, Kilo, or any generic CLI, and let `orchestrator` run the
graph while preserving inputs, intermediate outputs, logs, manifests, and final
results under `.orchestrator/`.

Crewplane is built around three ideas:

- Workflows are Markdown files with explicit dependencies.
- Providers are external CLIs, not vendor SDK integrations.
- Execution state is written to disk as readable artifacts.

## Install

Recommended isolated install:

```bash
uv tool install crewplane
```

The public package name is `crewplane`. The installed command is
`orchestrator`.

Provider CLIs are installed and authenticated separately. Crewplane does not install provider CLIs, does not manage provider credentials, and does not sandbox provider CLI execution.

## First Run

```bash
orchestrator init
orchestrator validate
orchestrator run --dry-run
orchestrator run
```

`orchestrator init` creates `.orchestrator/config.yml`, a default workflow, and
additional example templates under `.orchestrator/workflows/example-templates/`.

## Workflow Shape

```yaml
---
schema_version: "<current>"
name: "Quick Review"
nodes:
  - id: review.context
    mode: parallel
    providers: ["claude", "codex"]
---

## review.context
Review the current repository and report the highest-risk issues.
```

Full workflow authoring docs are in the
[workflow syntax reference](https://github.com/crewplaneai/crewplane/blob/main/docs/reference/workflow-syntax.md).

## Safety Boundary

Crewplane coordinates provider CLIs; it is not a security sandbox. Provider CLIs
run with the permissions, approval mode, network access, and filesystem access
configured for those tools.

`{{file:path}}` template references are bounded to the project root by default.
External files must be explicitly allowlisted with
`settings.integrations.artifacts.options.allowed_template_paths`.

## Where Next

- [Documentation index](https://github.com/crewplaneai/crewplane/blob/main/docs/index.md)
- [Installation](https://github.com/crewplaneai/crewplane/blob/main/docs/getting-started/installation.md)
- [Quickstart](https://github.com/crewplaneai/crewplane/blob/main/docs/getting-started/quickstart.md)
- [Provider setup](https://github.com/crewplaneai/crewplane/blob/main/docs/getting-started/provider-setup.md)
- [Examples](https://github.com/crewplaneai/crewplane/blob/main/docs/examples/index.md)
- [Command reference](https://github.com/crewplaneai/crewplane/blob/main/docs/reference/commands.md)
- [Configuration reference](https://github.com/crewplaneai/crewplane/blob/main/docs/reference/configuration.md)
- [Workflow syntax reference](https://github.com/crewplaneai/crewplane/blob/main/docs/reference/workflow-syntax.md)
- [Artifact reference](https://github.com/crewplaneai/crewplane/blob/main/docs/reference/artifacts.md)
- [Security and trust](https://github.com/crewplaneai/crewplane/blob/main/docs/safety/security-and-trust.md)
- [Architecture](https://github.com/crewplaneai/crewplane/blob/main/docs/architecture/index.md)
- [Contributing and local development](https://github.com/crewplaneai/crewplane/blob/main/DEVELOPMENT.md)
