Skip to content

Remove Quick start section with incorrect commands #22

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
teallarson merged 5 commits into from
Mar 5, 2026
Merged

Remove Quick start section with incorrect commands #22

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
99c93e8
Restore public README lost in #20, bump to 0.3.1
teallarson Mar 5, 2026
7dea543
Remove Quick start section with incorrect npm create commands
teallarson Mar 5, 2026
e7821f9
Fix Key files table: remove deleted chat route, fix db path
teallarson Mar 5, 2026
b2bce51
Bump to 0.3.2
teallarson Mar 5, 2026
0dfefbb
Merge main, keep README fixes and 0.3.2 version
teallarson Mar 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 1 addition & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,29 +12,6 @@ The default template is a daily planning and triage assistant (Slack, Google Cal
- **An Arcade account** -- sign up at [arcade.dev](https://arcade.dev) and create an MCP Gateway at [app.arcade.dev/mcp-gateways](https://app.arcade.dev/mcp-gateways)
- **An LLM API key** -- either an [OpenAI API key](https://platform.openai.com) or an [Anthropic API key](https://console.anthropic.com) (if both are set, Anthropic takes priority)

## Quick start

### TypeScript templates (ai-sdk, mastra)

```bash
npm create @arcadeai/agent my-agent -- --template ai-sdk
cd my-agent
cp .env.example .env # add your keys
bun run dev
```

> Or with `npx`: `npx @arcadeai/create-agent my-agent --template ai-sdk`

### Python template (langchain)

```bash
npm create @arcadeai/agent my-agent -- --template langchain
cd my-agent
cp .env.example .env # add your keys
source .venv/bin/activate
uvicorn app.main:app --host localhost --port 8765
```

## Templates

| Template | Flag value | Tech stack | UI |
Expand Down Expand Up @@ -70,8 +47,7 @@ Rather than listing every generated file, here are the ones you'll actually touc
| `system-prompt.md` | Agent personality and purpose |
| `agent.ts` / `agent.py` | Model and provider config |
| `lib/arcade.ts` / `arcade_oauth.py` | MCP client setup |
| `app/api/chat/` / `routes/chat.py` | Streaming chat endpoint |
| `db/` schema files | Data layer |
| `lib/db/` schema files | Data layer |
| `.env` | Configuration |

The `mastra` template places agent and tool definitions under `src/mastra/` instead of `lib/`.
Expand Down
4 changes: 2 additions & 2 deletions package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@arcadeai/create-agent",
"version": "0.3.1",
"version": "0.3.2",
"type": "module",
"description": "Scaffold an Arcade-powered AI agent",
"license": "MIT",
Expand Down