# 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)

```bash
python -m venv .venv
source .venv/bin/activate
pip install -e .[dev]
```

## Create a new project

```bash
# 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

```bash
# 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.
