Skip to content

Add CLAUDE.md with project overview #5

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
evantahler merged 3 commits into from
Feb 17, 2026
Merged

Add CLAUDE.md with project overview #5

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b4567ed
Add CLAUDE.md with project overview and developer reference
evantahler Feb 17, 2026
5288424
Fix prettier formatting in CLAUDE.md
evantahler Feb 17, 2026
e44e85c
Add bun format reminder to CLAUDE.md CI section
evantahler Feb 17, 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
39 changes: 39 additions & 0 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# CLAUDE.md

## What This Is

CLI agent template built with Bun + TypeScript. Provides an interactive chat interface powered by OpenAI's agent framework with Arcade.dev toolkit integration. Designed as a starting point for engineers building AI agents with external tool execution.

## Commands

| Command | Purpose |
| ---------------------------------------------- | -------------------------------------- |
| `bun install` | Install dependencies |
| `bun test` | Run tests (mocked, no API keys needed) |
| `bun lint` | Check formatting (Prettier) |
| `bun format` | Fix formatting |
| `bun build agent.ts --compile --outfile agent` | Compile to standalone binary |
| `./agent.ts chat [message]` | Run the agent |

## Project Structure

- `agent.ts` — CLI entry point (Commander.js). Single `chat` command with `-t, --toolkits` option
- `classes/wrappedAgent.ts` — Abstract base agent with streaming, conversation history, interactive REPL
- `classes/config.ts` — Loads required env vars: `OPENAI_API_KEY`, `OPENAI_MODEL`, `LOG_LEVEL`, `ARCADE_API_KEY`, `USER_ID`
- `classes/logger.ts` — Logging with levels, colors (chalk), spinners (ora), tool call tracking
- `agents/general.ts` — Main agent implementation extending WrappedAgent
- `utils/tools.ts` — Arcade.dev toolkit → OpenAI agent tool conversion
- `utils/client.ts` — OpenAI client initialization
- `tests/` — Tests for CLI parsing, config loading, and logger

## Environment

- Runtime: Bun (v1.2.9+)
- TypeScript with ESNext target, bundler module resolution
- See `.env.example` for required environment variables

## CI

GitHub Actions runs three jobs: compile, lint, test. All must pass.

Run `bun format` before committing to avoid lint failures.