create-agent-ui
Version:
CLI tool to create an Agent UI with one command
72 lines (48 loc) • 1.27 kB
Markdown
# create-agent-ui
A CLI tool that helps you quickly create a new Agent UI project. It sets up everything you need to get started with your Agent UI template.
## Usage
```bash
# Using npx (recommended)
npx create-agent-ui my-agent-app
# Using yarn
yarn create agent-ui@latest my-agent-app
# Using pnpm
pnpm create agent-ui@latest my-agent-app
# Using bun
bunx create-agent-ui@latest my-agent-app
```
The CLI will automatically:
1. Create a new directory with your project name
2. Clone the latest version of the Agent UI template
3. Remove git history to start fresh
4. Optionally install dependencies based on your choice
## Prerequisites
- Node.js (v14 or higher)
- Git
- One of the following package managers:
- npm
- yarn
- pnpm
- bun
## Development
### Testing Locally
You can test the CLI locally by running:
```bash
npx create-agent-ui my-agent-app --local
```
## After Installation
Once your project is created:
1. Navigate to your project directory:
```bash
cd your-project-name
```
2. If you didn't install dependencies during setup:
```bash
pnpm install # or yarn, npm, bun install
```
3. Start the development server:
```bash
pnpm run dev # or yarn dev, npm dev, bun dev
```
## License
MIT License