Skip to content

Commit 219bd36

Browse files
authored
docs: finish gitclaw->gitagent rename in README FAQ (#44)
The FAQ section (added in #35) landed after the rename branch point, so its gitclaw references survived the squash merge of #43. Renamed them and fixed the circular 'formerly GitAgent' note to 'GitAgent (formerly Gitclaw)'.
1 parent d32e526 commit 219bd36

1 file changed

Lines changed: 10 additions & 10 deletions

File tree

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -733,11 +733,11 @@ Contributions are welcome! Please see [CONTRIBUTING.md](./CONTRIBUTING.md) for g
733733

734734
### General
735735

736-
**What is Gitclaw?**
737-
Gitclaw (formerly GitAgent) is a git-native AI agent framework where the agent IS a git repository. Identity, rules, memory, tools, and skills are all version-controlled files, enabling "agents as repos" paradigm.
736+
**What is Gitagent?**
737+
GitAgent (formerly Gitclaw) is a git-native AI agent framework where the agent IS a git repository. Identity, rules, memory, tools, and skills are all version-controlled files, enabling "agents as repos" paradigm.
738738

739-
**How does Gitclaw differ from other agent frameworks?**
740-
Unlike frameworks that scatter configuration across application code, Gitclaw makes the agent itself a git repo:
739+
**How does Gitagent differ from other agent frameworks?**
740+
Unlike frameworks that scatter configuration across application code, Gitagent makes the agent itself a git repo:
741741
- Fork an agent → inherit personality, rules, tools
742742
- Branch → create alternate personality versions
743743
- `git log` → see agent's memory evolution
@@ -756,7 +756,7 @@ Your agent lives in a git repository with structured files:
756756
### Installation & Setup
757757

758758
**What are the requirements?**
759-
Node.js 18+ (or 20+ recommended), npm, and git. Install globally with `npm install -g gitclaw`.
759+
Node.js 18+ (or 20+ recommended), npm, and git. Install globally with `npm install -g gitagent`.
760760

761761
**How do I set up API keys?**
762762
Run the installer for guided setup:
@@ -773,14 +773,14 @@ export OPENAI_API_KEY="sk-..."
773773
- Anthropic (Claude models via native SDK)
774774
- Any OpenAI-compatible provider
775775

776-
Use `--model` flag to override: `gitclaw --model anthropic:claude-sonnet-4-5-20250929`
776+
Use `--model` flag to override: `gitagent --model anthropic:claude-sonnet-4-5-20250929`
777777

778778
### Core Concepts
779779

780780
**What is the SDK and how do I use it?**
781781
The SDK provides programmatic access via `query()` function that streams agent events:
782782
```typescript
783-
import { query } from "gitclaw";
783+
import { query } from "gitagent";
784784
for await (const msg of query({ prompt: "hello", model: "openai:gpt-4o-mini" })) {
785785
if (msg.type === "delta") process.stdout.write(msg.content);
786786
}
@@ -789,9 +789,9 @@ for await (const msg of query({ prompt: "hello", model: "openai:gpt-4o-mini" }))
789789
**How do local repo mode sessions work?**
790790
Clone a GitHub repo, run an agent on it, auto-commit to a session branch:
791791
```bash
792-
gitclaw --repo https://github.com/org/repo --pat ghp_xxx "Fix the bug"
792+
gitagent --repo https://github.com/org/repo --pat ghp_xxx "Fix the bug"
793793
```
794-
Resume with: `gitclaw --repo URL --session gitclaw/session-xxx "Continue"`
794+
Resume with: `gitagent --repo URL --session gitagent/session-xxx "Continue"`
795795

796796
**What hooks are available?**
797797
Hooks are lifecycle scripts or programmatic handlers in `hooks/` directory. They trigger on agent events like tool execution, session start/end, or memory updates.
@@ -819,7 +819,7 @@ OpenTelemetry integration for observability:
819819
- Check `agent.yaml` model configuration
820820

821821
**How do I debug agent behavior?**
822-
- Use console exporter: `OTEL_TRACES_EXPORTER=console gitclaw -p "test"`
822+
- Use console exporter: `OTEL_TRACES_EXPORTER=console gitagent -p "test"`
823823
- Check spans in Jaeger: `docker run -p 16686:16686 -p 4318:4318 jaegertracing/all-in-one`
824824
- Inspect `memory/` directory for agent state
825825

0 commit comments

Comments
 (0)