HAL9000
fcafb671d3
CI / status-check (pull_request) Blocked by required conditions
CI / lint (pull_request) Successful in 1m5s
CI / typecheck (pull_request) Successful in 1m23s
CI / quality (pull_request) Successful in 1m27s
CI / benchmark-publish (pull_request) Has been skipped
CI / security (pull_request) Successful in 1m34s
CI / helm (pull_request) Successful in 38s
CI / push-validation (pull_request) Successful in 29s
CI / build (pull_request) Successful in 46s
CI / benchmark-regression (pull_request) Failing after 39s
CI / integration_tests (pull_request) Successful in 3m21s
CI / e2e_tests (pull_request) Successful in 3m20s
CI / unit_tests (pull_request) Successful in 6m36s
CI / docker (pull_request) Failing after 1s
CI / coverage (pull_request) Failing after 16m55s
Add docs/quickstart.md with end-to-end quick start guide covering prerequisites, installation, project creation, resource registration, plan/apply workflow, and troubleshooting. Update mkdocs.yml navigation to include Quick Start page and rename ADR-028 title to Skill/Tool Abstraction Definition. Update CHANGELOG.md with quick start guide entry. Closes #9245
1.0 KiB
1.0 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
# Generate a plan
cleveragents plan --project my-project
# Review the plan, then apply
cleveragents apply --project my-project
Troubleshooting
If you encounter issues running the examples above, consult docs/development/testing.md and the project README for local development tips.