Skip to content

Open source AI coding agent. Designed for large projects and real world tasks.

Add Claude Pro/Max subscription documentation

Dane Schneidere461209030e3
diff --git a/docs/docs/cli-reference.md b/docs/docs/cli-reference.md
index b626ebcf..cc6d8cb2 100644
--- a/docs/docs/cli-reference.md
+++ b/docs/docs/cli-reference.md
@@ -849,6 +849,24 @@ List users and pending invites in your org.
plandex users
```
+## Integrations
+
+### connect-claude
+
+Connect a Claude Pro or Max subscription. When Plandex calls Anthropic models, it will use your Claude subscription up to its quota.
+
+```bash
+plandex connect-claude
+```
+
+### disconnect-claude
+
+```bash
+plandex disconnect-claude
+```
+
+Disconnect your Claude Pro or Max subscription and clear credentials from your device.
+
## Plandex Cloud
### billing
diff --git a/docs/docs/models/built-in/_category_.json b/docs/docs/models/built-in/_category_.json
index 1318dcd6..b6ae74a3 100644
--- a/docs/docs/models/built-in/_category_.json
+++ b/docs/docs/models/built-in/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Built-In",
- "position": 8,
+ "position": 9,
"collapsible": true,
"collapsed": false
}
\ No newline at end of file
diff --git a/docs/docs/models/claude-subscription.md b/docs/docs/models/claude-subscription.md
new file mode 100644
index 00000000..14c680a9
--- /dev/null
+++ b/docs/docs/models/claude-subscription.md
@@ -0,0 +1,42 @@
+---
+sidebar_position: 3
+sidebar_label: Claude Pro/Max
+---
+
+# Claude Pro/Max Subscription
+
+If you have a Claude Pro or Max subscription, Plandex can use it when calling Anthropic models. You can use it in either Integrated Models Mode on Plandex Cloud, or in BYO Key Mode (whether on Cloud or self-hosting).
+
+## Startup Prompt
+
+Assuming you're using Anthropic models (which the default model pack does), you'll be asked if you want to connect your Claude subscription the first time you run Plandex. Follow the instructions to connect.
+
+## CLI Commands
+
+### `connect-claude`
+
+You can connect your subscription with the `connect-claude` command.
+
+```bash
+plandex connect-claude # CLI
+\connect-claude # REPL
+```
+
+### `disconnect-claude`
+
+You can disconnect your subscription and clear credentials from your device with the `disconnect-claude` command.
+
+```bash
+plandex disconnect-claude # CLI
+\disconnect-claude # REPL
+```
+
+## Quota Exhaustion
+
+If you're using Plandex Cloud with Integrated Models Mode, Anthropic model calls will use your Claude subscription until it runs out of quota, then switch to using Plandex credits until the quota resets.
+
+If you're self-hosting or using Plandex Cloud in BYO API Key Mode, Anthropic model calls will use your Claude subscription until it runs out of quota, then:
+
+- If you have an API key or credentials set for an [Anthropic provider](./model-providers.md) (like the Anthropic API, Google Vertex AI, AWS Bedrock, or OpenRouter), Plandex will switch to the backup provider until the quota resets.
+
+- If you have no API key or credentials set for an Anthropic provider, you'll get a rate limit error until your quota resets.
\ No newline at end of file
diff --git a/docs/docs/models/custom-models.md b/docs/docs/models/custom-models.md
index 5bf677d9..a838a237 100644
--- a/docs/docs/models/custom-models.md
+++ b/docs/docs/models/custom-models.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 4
+sidebar_position: 5
sidebar_label: Custom Models
---
diff --git a/docs/docs/models/model-providers.md b/docs/docs/models/model-providers.md
index cbef2bae..ec140125 100644
--- a/docs/docs/models/model-providers.md
+++ b/docs/docs/models/model-providers.md
@@ -34,6 +34,10 @@ Many models can be served by multiple different providers. For example, OpenAI m
When multiple providers are available for a model, which provider is selected depends on the authentication environment variables that are set when running the CLI or REPL. If environment variables are set for multiple providers, the direct provider takes precedence. For example, if you set both `ANTHROPIC_API_KEY` (for the direct Anthropic API) and `OPENROUTER_API_KEY` (for OpenRouter), Plandex will use the direct Anthropic API for Anthropic models.
+## Claude Pro/Max Subscription
+
+If you have a Claude Pro or Max subscription, Plandex can use it when calling Anthropic models. [Learn more.](./claude-subscription.md)
+
## Built-In Providers
### OpenRouter
diff --git a/docs/docs/models/model-settings.md b/docs/docs/models/model-settings.md
index b7ded8d6..b4b9ff1d 100644
--- a/docs/docs/models/model-settings.md
+++ b/docs/docs/models/model-settings.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 3
+sidebar_position: 4
sidebar_label: Settings
---
diff --git a/docs/docs/models/ollama.md b/docs/docs/models/ollama.md
index 12f079a1..6291d279 100644
--- a/docs/docs/models/ollama.md
+++ b/docs/docs/models/ollama.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 7
+sidebar_position: 8
sidebar_label: Ollama Quickstart
---
diff --git a/docs/docs/models/roles.md b/docs/docs/models/roles.md
index 2220df8c..542a0c32 100644
--- a/docs/docs/models/roles.md
+++ b/docs/docs/models/roles.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 5
+sidebar_position: 6
sidebar_label: Roles
---