Skip to content

Commit aabf066

Browse files
authored
docs: reflecting benefits of CLI providers (aaif-goose#3399)
1 parent 5db89aa commit aabf066

1 file changed

Lines changed: 35 additions & 37 deletions

File tree

documentation/docs/guides/cli-providers.md

Lines changed: 35 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,44 @@
11
---
2-
sidebar_position: 25
2+
sidebar_position: 8
33
title: CLI Providers
44
sidebar_label: CLI Providers
5+
description: Use Claude Code or Gemini CLI subscriptions in Goose
56
---
67

78
# CLI Providers
89

9-
Goose supports two special pass-through providers that leverage existing CLI tools and extensions from Anthropic and Google. These providers allow you to use your existing subscriptions to Claude Code and Google Gemini CLI tools directly through Goose, providing a cost-effective way to access these excellent AI models and tools while maintaining the benefits of Goose's ecosystem and working with multiple models and extensions.
10+
Goose supports pass-through providers that integrate with existing CLI tools from Anthropic and Google. These providers allow you to use your existing Claude Code and Google Gemini CLI subscriptions through Goose's interface, adding session management, persistence, and workflow integration capabilities to these tools.
1011

11-
## Overview
12+
## Why Use CLI Providers?
1213

13-
CLI providers are different from traditional LLM providers in several key ways:
14+
CLI providers are useful if you:
15+
16+
- already have a Claude Code or Google Gemini CLI subscription and want to use it through Goose instead of paying per token
17+
- need session persistence to save, resume, and export conversation history
18+
- want to use Goose recipes and scheduled tasks to create repeatable workflows
19+
- prefer unified commands across different AI providers
20+
- want to [use multiple models together](#combining-with-other-models) in your tasks
21+
22+
### Benefits
23+
24+
#### Session Management
25+
- **Persistent conversations**: Save and resume sessions across restarts
26+
- **Export capabilities**: Export conversation history and artifacts
27+
- **Session organization**: Manage multiple conversation threads
28+
29+
#### Workflow Integration
30+
- **Recipe compatibility**: Use CLI providers in automated Goose recipes
31+
- **Scheduling support**: Include in scheduled tasks and workflows
32+
- **Hybrid configurations**: Combine with LLM providers using lead/worker patterns
33+
34+
#### Interface Consistency
35+
- **Unified commands**: Use the same `goose session` interface across all providers
36+
- **Consistent configuration**: Manage all providers through Goose's configuration system
37+
38+
:::warning Extensions
39+
CLI providers do **not** give you access to Goose's extension ecosystem (MCP servers, third-party integrations, etc.). They use their own built-in tools to prevent conflicts. If you need Goose's extensions, use standard [API providers](/docs/getting-started/providers#available-providers) instead.
40+
:::
1441

15-
- **Pass-through architecture**: Instead of making direct API calls, these providers drive the CLI commands
16-
- **Subscription-based**: Use your existing Claude Code or Google Gemini CLI subscriptions instead of paying per token (usually a flat monthly fee)
17-
- **Tool integration**: These providers work with their respective CLI tools' built-in capabilities while Goose manages sessions and extensions
18-
- **Cost-effective**: Leverage unlimited or subscription-based pricing models instead of token-based billing
1942

2043
## Available CLI Providers
2144

@@ -47,7 +70,7 @@ The Gemini CLI provider integrates with Google's [Gemini CLI tool](https://ai.go
4770

4871
## Setup Instructions
4972

50-
### Setting up Claude Code Provider
73+
### Claude Code
5174

5275
1. **Install Claude CLI Tool**
5376

@@ -81,7 +104,7 @@ The Gemini CLI provider integrates with Google's [Gemini CLI tool](https://ai.go
81104
│ default
82105
```
83106

84-
### Setting up Gemini CLI Provider
107+
### Gemini CLI
85108

86109
1. **Install Gemini CLI Tool**
87110

@@ -170,13 +193,7 @@ Both CLI providers automatically filter out Goose's extension information from s
170193
- **Claude Code**: Parses JSON responses to extract text content and usage information
171194
- **Gemini CLI**: Processes plain text responses from the CLI tool
172195

173-
## Limitations and Considerations
174-
175-
### Tool Calling
176-
177-
These providers handle tool calling differently than standard API providers as they have their own tool integrations out of the box.
178-
179-
### Error Handling
196+
## Error Handling
180197

181198
CLI providers depend on external tools, so ensure:
182199

@@ -185,25 +202,6 @@ CLI providers depend on external tools, so ensure:
185202
- Subscription limits are not exceeded
186203

187204

188-
## Benefits
189-
190-
### Cost Effectiveness
191-
192-
- **Subscription-based pricing**: Use unlimited or fixed-price subscriptions instead of per-token billing
193-
- **Existing subscriptions**: Leverage subscriptions you may already have
194-
195-
### Flexibility
196-
197-
- **Hybrid usage**: Combine CLI providers with API-based providers using lead/worker patterns
198-
- **Session management**: Full Goose session management and extension system
199-
- **Easy switching**: Switch between CLI and API providers as needed
200-
201-
## Best Practices
202-
203-
1. **Authentication Management**: Keep CLI tools authenticated and monitor subscription status
204-
2. **Hybrid Approaches**: Consider using CLI providers for heavy workloads and API providers for quick tasks
205-
3. **Backup Providers**: Configure fallback API providers in case CLI tools are unavailable
206-
207205
---
208206

209-
CLI providers offer a powerful way to integrate Goose with existing AI tool subscriptions while maintaining the benefits of Goose's session management. They're particularly valuable for users with existing subscriptions who want to maximize their investment while gaining access to Goose's capabilities.
207+
CLI providers offer a way to use existing AI tool subscriptions through Goose's interface, adding session management and workflow integration capabilities. They're particularly valuable for users with existing CLI subscriptions who want unified session management and recipe integration.

0 commit comments

Comments
 (0)