Skip to content

Commit 57b3fd7

Browse files
author
Test
committed
Update docs: add gt go command, web search tool, and setup improvements
- Add gt go command documentation (quick AI answers) - Document web_search tool with EXA_API_KEY setup - Update setup commands with --yes flag - Add tools reference section
1 parent 3c65bd6 commit 57b3fd7

File tree

2 files changed

+91
-5
lines changed

2 files changed

+91
-5
lines changed

README.md

Lines changed: 23 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,11 @@ gt setup
3838
Use `gptcode` or the short alias `gt`:
3939

4040
```bash
41-
# Autonomous mode - AI completes the task
41+
# Quick AI answers (no tool loop - fastest)
42+
gt go "what is Go language"
43+
gt go "write hello world in Python"
44+
45+
# Autonomous mode - AI completes the task with tools
4246
gt do "add user authentication"
4347

4448
# Interactive chat
@@ -55,7 +59,8 @@ gt research "how does the payment system work?"
5559

5660
| Command | Description |
5761
|---------|-------------|
58-
| `gt do "task"` | Autonomous task completion |
62+
| `gt go "question"` | Quick AI answer (no tools) - fastest |
63+
| `gt do "task"` | Autonomous task completion with tools |
5964
| `gt chat` | Interactive code conversation |
6065
| `gt run "task"` | Execute with follow-up |
6166
| `gt research "question"` | Document codebase/architecture |
@@ -65,6 +70,22 @@ gt research "how does the payment system work?"
6570
| `gt tdd` | Test-driven development mode |
6671
| `gt feature "desc"` | Generate tests + implementation |
6772

73+
## Tools Available
74+
75+
When using autonomous modes (`gt do`, `gt run`, `gt chat`), these tools are available:
76+
77+
| Tool | Description |
78+
|------|-------------|
79+
| `read_file` | Read file contents |
80+
| `list_files` | List files with pattern filter |
81+
| `search_code` | Regex search in code |
82+
| `find_relevant_files` | AI-powered file discovery |
83+
| `write_file` | Create/edit files |
84+
| `apply_patch` | Replace text blocks |
85+
| `run_command` | Execute shell commands |
86+
| `project_map` | Project structure tree |
87+
| `web_search` | Web lookup (requires EXA_API_KEY) |
88+
6889
## Skills
6990

7091
Language-specific guidelines injected into prompts:

docs/reference/commands.md

Lines changed: 68 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -149,18 +149,25 @@ Initialize GPTCode configuration at `~/.gptcode`.
149149
gt setup
150150
```
151151

152+
Or use Quick Start for non-interactive setup:
153+
154+
```bash
155+
gt setup -y
156+
```
157+
152158
Creates:
153159
- `~/.gptcode/profile.yaml` – backend and model configuration
154160
- `~/.gptcode/system_prompt.md` – base system prompt
155161
- `~/.gptcode/memories.jsonl` – memory store for examples
162+
- `~/.gptcode/feedback_hook.zsh` – shell feedback hook for learning
156163

157-
### `gptcode key [backend]`
164+
### `gt key [backend]`
158165

159166
Add or update API key for a backend provider.
160167

161168
```bash
162-
gptcode key openrouter
163-
gptcode key groq
169+
gt key openrouter
170+
gt key groq
164171
```
165172

166173
### `gt models update`
@@ -175,6 +182,30 @@ gt models update
175182

176183
## Interactive Modes
177184

185+
### `gt go [question]`
186+
187+
**NEW**: Direct AI answers without tool execution. Fastest mode for quick questions.
188+
189+
```bash
190+
gt go "what is Go language"
191+
gt go "explain what a goroutine is"
192+
gt go "write hello world in Python"
193+
gt go "what does this error mean: nil pointer"
194+
```
195+
196+
**When to use:**
197+
- Quick questions
198+
- Simple explanations
199+
- Code generation without execution
200+
- Fast answers without autonomous loop
201+
202+
**Difference from other modes:**
203+
| Mode | Tools | Use Case |
204+
|------|-------|----------|
205+
| `gt go` || Quick Q&A, code snippets |
206+
| `gt run` || Tasks requiring file operations |
207+
| `gt do` || Complex autonomous tasks |
208+
178209
### `gt chat`
179210

180211
Code-focused conversation mode. Routes queries to appropriate agents based on intent.
@@ -587,6 +618,7 @@ Shows:
587618
588619
| Command | Purpose | When to Use |
589620
|---------|---------|-------------|
621+
| `go` | Quick AI answer | Fast Q&A, code snippets |
590622
| `chat` | Interactive conversation | Quick questions, exploratory work |
591623
| `review` | Code review | Before commit, quality check, security audit |
592624
| `tdd` | TDD workflow | New features requiring tests |
@@ -598,6 +630,39 @@ Shows:
598630
599631
---
600632
633+
## Tools Reference
634+
635+
Available tools in autonomous modes (`gt do`, `gt run`, `gt chat`):
636+
637+
| Tool | Description |
638+
|------|-------------|
639+
| `read_file` | Read file contents |
640+
| `list_files` | List directory with optional glob pattern filter |
641+
| `search_code` | Regex search across code files |
642+
| `find_relevant_files` | AI-powered file discovery by keywords |
643+
| `write_file` | Create or overwrite files |
644+
| `apply_patch` | Replace text blocks in files |
645+
| `run_command` | Execute shell commands |
646+
| `project_map` | Get tree view of project structure |
647+
| `read_guideline` | Read coding guidelines |
648+
| `web_search` | Search the web (requires EXA_API_KEY) |
649+
650+
### Web Search Configuration
651+
652+
To enable web search:
653+
654+
```bash
655+
# Get free API key from https://exa.ai
656+
export EXA_API_KEY="your-key"
657+
658+
# Or use SEARCH_API_KEY env var
659+
export SEARCH_API_KEY="your-key"
660+
```
661+
662+
Without API key, the tool shows setup instructions.
663+
664+
---
665+
601666
## Backend Management
602667
603668
### `gt backend`

0 commit comments

Comments
 (0)