crewplane 0.1.0__tar.gz

crewplane-0.1.0/.gitignore

@@ -0,0 +1,127 @@
+# Python cache and tooling
+__pycache__/
+*.py[cod]
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+*$py.class
+
+# Build artifacts
+build/
+dist/
+site/
+.eggs/
+*.egg-info/
+pip-wheel-metadata/
+.wheels/
+
+# Release/build manifests
+.release/
+.release-manifests/
+release-manifest.json
+release-manifest.*.json
+build-manifest.json
+build-manifest.*.json
+*.build-manifest.json
+
+# Local virtual environments
+.venv/
+venv/
+env/
+ENV/
+.python-version
+
+# ---- Test / coverage / type-checking ----
+.pytest_cache/
+.mypy_cache/
+.pyre/
+.pytype/
+.ruff_cache/
+.hypothesis/
+.tox/
+.nox/
+.coverage
+.coverage.*
+htmlcov/
+coverage.xml
+dmypy.json
+
+# ---- Logs / runtime ----
+*.log
+logs/
+tmp/
+tmp/**
+.crewplane/
+.orchestrator/
+*.pid
+*.sqlite3
+*.db
+
+# ---- Environment / secrets ----
+.env
+.env.*
+!.env.example
+*.pem
+*.key
+*.crt
+*.p12
+*.pfx
+*.asc
+*.kdbx
+secrets/
+secret/
+credentials/
+*.secret
+
+# ---- IDE / editor ----
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# ---- OS files ----
+.DS_Store
+Thumbs.db
+
+# ---- JS / docs site outputs (if you add a website later) ----
+node_modules/
+.next/
+out/
+.vercel/
+dist-ssr/
+
+# ---- Playwright / browser tooling ----
+playwright-report/
+test-results/
+
+# ---- Local AI tool state ----
+.claude/
+.codex/
+.cursor/
+.gemini/
+.gemini/
+.agent/
+.agents/*
+!.agents/skills/
+.agents/skills/*
+!.agents/skills/create-workflows/
+!.agents/skills/create-workflows/**
+.claude/
+.kilocode/
+.kiro/
+
+# ---- Generated demos / recordings (commit only curated assets) ----
+*.cast
+*.webm
+*.mp4
+
+# ---- Mac / Linux shell history or misc local files ----
+.history/
+.cache/
+
+# Local runtime artifacts
+.serena/
+docs/maintainers/
+scripts/internal/
+!packaging/npm/scripts/
+!packaging/npm/scripts/**

crewplane-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

crewplane-0.1.0/PKG-INFO

@@ -0,0 +1,211 @@
+Metadata-Version: 2.4
+Name: crewplane
+Version: 0.1.0
+Summary: A Markdown-native control plane for AI coding CLIs
+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/master/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
+
+<div align="center">
+  <h1>Crewplane</h1>
+  <p>A Markdown-native control plane for AI coding CLIs.</p>
+  <p>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/CHANGELOG.md"><img alt="Status: alpha" src="https://img.shields.io/badge/status-alpha-f59e0b.svg"></a>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/pyproject.toml"><img alt="Python 3.13+" src="https://img.shields.io/badge/python-3.13%2B-3776AB.svg"></a>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/LICENSE"><img alt="License: Apache-2.0" src="https://img.shields.io/badge/license-Apache--2.0-blue.svg"></a>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/docs/index.md"><img alt="Docs" src="https://img.shields.io/badge/docs-read-0f766e.svg"></a>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/SECURITY.md"><img alt="Security policy" src="https://img.shields.io/badge/security-policy-b91c1c.svg"></a>
+    <a href="https://github.com/crewplaneai/crewplane/blob/master/CONTRIBUTING.md"><img alt="Contributing" src="https://img.shields.io/badge/contributing-guide-6b7280.svg"></a>
+  </p>
+  <img src="https://raw.githubusercontent.com/crewplaneai/crewplane/master/.github/crewplane-splash.png" alt="Crewplane splash" width="80%">
+</div>
+
+---
+
+## Why Crewplane?
+
+You've got powerful AI tools at your fingertips — Claude Code, Codex CLI, Gemini CLI, and others. Each has its strengths, but tying their work into a single repeatable pipeline usually means shell scripts, brittle glue, and state scattered across temp files.
+
+**Crewplane gives your project a control plane for your agent crews.** Write the workflow once in Markdown, assign each step to whichever AI agent fits best, and Crewplane handles the rest — parallel, fan-out, sequential handoffs, retries, and a complete paper trail.
+
+No SDKs. No plugins. No vendor lock-in. If your AI tool has a CLI, it works.
+
+**Every step is a Markdown file.** Inputs, outputs, reviews — all saved to `.crewplane/execution-stages/` as readable Markdown. Inspect any step in your editor, diff it in git, or debug with `cat`. Nothing is a black box.
+
+| vs. Other Frameworks | Crewplane |
+|---------------------|------------------|
+| **Autonomous loops** | Explicit DAG control — define exactly how agents work together, in sequence or in parallel |
+| **Hidden state** | Externalized to markdown — fully auditable |
+| **Tight SDK coupling** | CLI-first — zero provider lock-in |
+| **Black box debugging** | Inspect `.crewplane/execution-stages/` at any step, final results saved in `.crewplane/execution-results/` |
+| **Adapter boilerplate** | Works with any CLI that reads/writes files |
+
+> *"Crewplane doesn't try to understand your AI tools. It just gives them a shared workspace and gets out of the way."*
+
+> ⚠️ **Security Note:** `{{file:path}}` templates are restricted to the project root by default. Use `settings.integrations.artifacts.options.allowed_template_paths` for explicit external-file allowlisting.
+
+## Installation
+
+Recommended isolated install:
+
+```bash
+uv tool install crewplane
+crewplane --help
+```
+
+Crewplane can also be installed with the following supported methods:
+
+```bash
+# pipx
+pipx install crewplane
+
+# pip
+python -m pip install crewplane
+
+# install script for macOS and Linux
+curl -fsSL https://raw.githubusercontent.com/crewplaneai/crewplane/master/install.sh | sh
+
+# Homebrew
+brew tap crewplaneai/crewplane && brew install crewplane
+
+# npm wrapper
+npm install -g crewplane
+```
+
+For a local checkout:
+
+```bash
+git clone https://github.com/crewplaneai/crewplane.git
+cd crewplane
+python -m pip install .
+```
+
+> ⚠️ **Note:** 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.
+
+See the [installation guide](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/installation.md) for update, uninstall, and npm `PATH` troubleshooting.
+
+## First Run
+
+```bash
+crewplane init
+crewplane validate
+crewplane run --no-live
+```
+
+`crewplane init` creates `.crewplane/config.yml`, a default workflow, and
+additional example templates under `.crewplane/workflows/example-templates/`.
+The default run uses deterministic `mock` output (no cost) and does not require provider
+CLIs, API keys, provider accounts, or config edits. It is scaffolding for
+validating the workflow and artifact path, not model output.
+
+Inspect the first run artifacts in `.crewplane/execution-stages/` and execution results in 
+`.crewplane/execution-results/`, then follow
+[provider setup](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/provider-setup.md)
+when you are ready to run real provider CLIs.
+
+## Live Dashboard
+
+For interactive runs, omit `--no-live` to open Crewplane's compact tmux
+dashboard (install tmux first if your system doesn't already have it).
+Re-running the same workflow? Add `--force` to skip the duplicate check:
+
+```bash
+crewplane run --force
+```
+
+The dashboard shows the workflow DAG, node status, selected provider output,
+and live log tails while the same durable artifacts are written under
+`.crewplane/`. It starts only when tmux is available, output is attached to a
+terminal, and provider log capture is enabled; otherwise Crewplane warns and
+continues with normal execution. See the
+[observability guide](https://github.com/crewplaneai/crewplane/blob/master/docs/guides/observability.md)
+for dashboard options and log inspection.
+
+## Workflow Shape
+
+```yaml
+---
+schema_version: "<current>"
+name: "Quick Review"
+nodes:
+  - id: review.project
+    mode: parallel
+    providers: ["mock"]
+---
+
+## review.project
+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/master/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.
+
+Experimental workspace isolation can move selected provider source-tree work
+into Git-backed worktrees or writable snapshots, but it is still source-tree
+isolation only. It does not sandbox provider execution.
+
+`{{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
+
+The default mock run gives you the same workflow machinery used for real
+provider runs, so you can inspect the shape of the system before connecting
+external CLIs:
+
+- 🔄 **DAG Execution** – Run independent nodes in parallel and dependency nodes in sequence
+- 🔍 **Cross-Review** – Agents review each other's outputs with structured verdict detection
+- 📝 **Task Files** – Frontmatter+Markdown (`.task.md`) workflows by default
+- 🔌 **Pluggable Providers** – Works with any CLI-based AI tool; no API keys or auth managed by Crewplane
+- 📁 **Project-Local Config** – Each project gets its own `.crewplane/` directory
+- 📂 **Transparent Artifacts** – Every intermediate step and final result saved to disk for full auditability
+- 🖥️ **Live Dashboard** – Optional tmux UI shows DAG progress, node status, and selected provider logs
+- 📊 **Spend Observability** – Run logs capture CLI capture status, provider token-report status, visible lower-bound estimates, and configured cost confidence summaries
+- ⚡ **Smart Caching** – Workflow-signature idempotency skips identical successes and resumes failed or cancelled runs from validated node boundaries
+- 🧪 **Experimental Workspace Isolation** – Opt-in Git-backed worktrees and writable snapshots can isolate provider source-tree edits in ordinary supported Git repositories
+
+When you are ready to configure a project, start with the quickstart and then
+move into provider setup, examples, and reference material as needed:
+
+- [Documentation index](https://github.com/crewplaneai/crewplane/blob/master/docs/index.md)
+- [Installation](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/installation.md)
+- [Quickstart](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/quickstart.md)
+- [Setup checklist](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/setup-checklist.md)
+- [Provider setup](https://github.com/crewplaneai/crewplane/blob/master/docs/getting-started/provider-setup.md)
+- [Examples](https://github.com/crewplaneai/crewplane/blob/master/docs/examples/index.md)
+- [Experimental workspace isolation](https://github.com/crewplaneai/crewplane/blob/master/docs/guides/workspace-isolation.md)
+- [Command reference](https://github.com/crewplaneai/crewplane/blob/master/docs/reference/commands.md)
+- [Configuration reference](https://github.com/crewplaneai/crewplane/blob/master/docs/reference/configuration.md)
+- [Workflow syntax reference](https://github.com/crewplaneai/crewplane/blob/master/docs/reference/workflow-syntax.md)
+- [Artifact reference](https://github.com/crewplaneai/crewplane/blob/master/docs/reference/artifacts.md)
+- [Security and trust](https://github.com/crewplaneai/crewplane/blob/master/docs/safety/security-and-trust.md)
+
+### Contributing
+
+If you're interested in contributing to Crewplane, please read our [Contributing and local development](https://github.com/crewplaneai/crewplane/blob/master/DEVELOPMENT.md) before submitting a pull request.