Skip to content

Commit b001645

Browse files
authored
docs(readme): add CLAUDE.md example (#39)
1 parent fc6f659 commit b001645

File tree

1 file changed

+39
-1
lines changed

1 file changed

+39
-1
lines changed

README.md

Lines changed: 39 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Hono CLI
22

3-
Hono CLI for Human and AI
3+
CLI for Human and AI with Hono
44

55
## Installation
66

@@ -233,6 +233,44 @@ hono serve \
233233

234234
## Tips
235235

236+
### Using Hono CLI with AI Code Agents
237+
238+
When working with AI code agents like Claude Code, you can configure them to use the `hono` CLI for efficient documentation access and testing. Add the following to your project's `CLAUDE.md` or similar configuration:
239+
240+
````markdown
241+
## Hono Development
242+
243+
Use the `hono` CLI for efficient development. View all commands with `hono --help`.
244+
245+
### Core Commands
246+
247+
- **`hono docs [path]`** - Browse Hono documentation
248+
- **`hono search <query>`** - Search documentation
249+
- **`hono request [file]`** - Test app requests without starting a server
250+
251+
### Quick Examples
252+
253+
```bash
254+
# Search for topics
255+
hono search middleware
256+
hono search "getting started"
257+
258+
# View documentation
259+
hono docs /docs/api/context
260+
hono docs /docs/guides/middleware
261+
262+
# Test your app
263+
hono request -P /api/users src/index.ts
264+
hono request -P /api/users -X POST -d '{"name":"Alice"}' src/index.ts
265+
```
266+
267+
### Workflow
268+
269+
1. Search documentation: `hono search <query>`
270+
2. Read relevant docs: `hono docs [path]`
271+
3. Test implementation: `hono request [file]`
272+
````
273+
236274
### Pipeline Integration with jq
237275

238276
The `search` command outputs JSON by default, making it easy to pipe results to other commands:

0 commit comments

Comments
 (0)