@artinet/create-quick-agent/README.md

A tool to create a Quick-Agent project via the CLI.

# `@artinet/create-quick-agent`

A command-line interface (CLI) tool to quickly scaffold starter agent projects from a predefined set of templates. `create-quick-agent` streamlines the initial setup process, allowing you to get your new agent project up and running in minutes.

From [the artinet project](https://artinet.io/).

## Prerequisites

*   [Node.js](https://nodejs.org/) (version 22.x or higher recommended, check `package.json` for specific engine requirements)
*   `npm` (comes with Node.js)

## Installation & Usage

The easiest way to use `create-quick-agent` is with `npx`, which ensures you're always using the latest version:

```bash
npx @artinet/create-quick-agent@latest
```

This command will initiate an interactive session:

1.  **Select a Template:** You'll be prompted to choose from the available agent templates.
    ```bash
    ? Select template › - Use arrow-keys. Return to submit.
    ❯   basic
        coder
        orchestrator
    ```
2.  **Enter Project Name:** You'll be asked to provide a name for your new project. This name will be used for the directory and in the project's `package.json`.
    ```bash
    ? Enter your project name › my-new-agent
    ```

## Available Templates

`create-quick-agent` currently offers the following templates:

*   **`basic`**: A minimal agent template, perfect for understanding the core structure or for simple agent tasks.
*   **`coder`**: A template pre-configured for developing agents with a focus on code generation, understanding, or manipulation tasks.
*   **`orchestrator`**: A template designed for building orchestrator agents that can manage and coordinate multiple other agents or tasks.

## Contributing

Contributions are welcome! If you have ideas for new templates, features, or improvements, please feel free to:

1.  Fork the repository.
2.  Create a new branch for your feature or bug fix.
3.  Make your changes.
4.  Submit a pull request.

Please report any bugs or issues by creating an issue on the GitHub repository.

## License

This project is licensed under the Apache License. See the [LICENSE](LICENSE) file for details.