HAL9000
f2d1f4efe7
CI / push-validation (push) Successful in 38s
CI / helm (push) Successful in 47s
CI / build (push) Successful in 1m2s
CI / lint (push) Successful in 1m14s
CI / quality (push) Successful in 1m23s
CI / typecheck (push) Successful in 1m47s
CI / security (push) Successful in 1m59s
CI / integration_tests (push) Successful in 4m2s
CI / e2e_tests (push) Successful in 4m35s
CI / unit_tests (push) Failing after 6m19s
CI / coverage (push) Has been skipped
CI / docker (push) Has been skipped
CI / status-check (push) Failing after 3s
CI / benchmark-regression (push) Has been skipped
CI / benchmark-publish (push) Successful in 1h17m32s
CI / benchmark-publish (pull_request) Has been skipped
CI / push-validation (pull_request) Successful in 43s
CI / helm (pull_request) Successful in 47s
CI / lint (pull_request) Successful in 1m21s
CI / quality (pull_request) Successful in 1m32s
CI / build (pull_request) Successful in 1m18s
CI / security (pull_request) Successful in 1m39s
CI / benchmark-regression (pull_request) Failing after 1m23s
CI / typecheck (pull_request) Successful in 2m14s
CI / integration_tests (pull_request) Successful in 4m16s
CI / unit_tests (pull_request) Failing after 4m59s
CI / coverage (pull_request) Has been skipped
CI / docker (pull_request) Has been skipped
CI / e2e_tests (pull_request) Successful in 4m52s
CI / status-check (pull_request) Failing after 3s
Update docs/quickstart.md to use correct CLI command signatures: - Replace 'cleveragents plan --project' with 'cleveragents plan use <action> --project' - Replace 'cleveragents apply --project' with 'cleveragents plan list' + 'cleveragents plan apply <plan-id>' Addresses reviewer non-blocking suggestion to verify CLI commands match actual signatures before merging.
1.1 KiB
1.1 KiB
Quick Start Guide
This quick start guide will walk you through creating a new project, registering a resource, running a plan, and applying changes with CleverAgents.
Prerequisites
- Python 3.11+ and virtualenv
- Git
- A working CleverAgents installation (see development/testing.md for details)
Install (local development)
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]
Create a new project
# Create a new directory for your project
mkdir my-project && cd my-project
# Initialize a CleverAgents project (example command)
cleveragents init --name my-project
Register a resource
Create a resource file under resources/ (example YAML) and register it with the CLI or API.
Plan and apply
# Create a plan using an action on your project
cleveragents plan use <action-name> --project my-project
# List plans to find the plan ID
cleveragents plan list
# Review the plan, then apply it by plan ID
cleveragents plan apply <plan-id>
Troubleshooting
If you encounter issues running the examples above, consult docs/development/testing.md and the project README for local development tips.