Open source AI coding agent. Designed for large projects and real world tasks.
Go aiai-agentsai-developer-toolsai-toolsclicommand-linedeveloper-toolsgitgolanggpt-4llmopenaipolyglot-programmingterminalterminal-basedterminal-ui
help/docs
Dane Schneiderfb33eeed49c6
diff --git a/app/cli/cmd/chat.go b/app/cli/cmd/chat.goindex 553cca3d..ed1c36e7 100644--- a/app/cli/cmd/chat.go+++ b/app/cli/cmd/chat.go@@ -13,7 +13,7 @@ import (var chatCmd = &cobra.Command{Use: "chat [prompt]",- Aliases: []string{"c"},+ Aliases: []string{"ct"},Short: "Chat without making changes",// Long: ``,Args: cobra.RangeArgs(0, 1),diff --git a/app/cli/plan_exec/tell.go b/app/cli/plan_exec/tell.goindex 06669bde..281a5f26 100644--- a/app/cli/plan_exec/tell.go+++ b/app/cli/plan_exec/tell.go@@ -166,9 +166,9 @@ func TellPlan(fmt.Println()if tellStop && !isChatOnly {- term.PrintCmds("", "continue", "diff", "diff --ui", "apply", "reject", "log", "rewind")+ term.PrintCmds("", "continue", "diff", "diff --ui", "apply", "log")} else if !isDebugCmd && !isChatOnly {- term.PrintCmds("", "diff", "diff --ui", "apply", "reject", "debug", "log", "rewind")+ term.PrintCmds("", "diff", "diff --ui", "apply", "log")} else if isChatOnly {term.PrintCmds("", "tell", "convo", "summary")}diff --git a/app/cli/term/help.go b/app/cli/term/help.goindex eff66353..ecc51bd8 100644--- a/app/cli/term/help.go+++ b/app/cli/term/help.go@@ -16,7 +16,7 @@ var CmdDesc = map[string][2]string{"cd": {"", "set current plan by name or index"},"load": {"l", "load files/dirs/urls/notes/images or pipe data into context"},"tell": {"t", "describe a task to complete"},- "chat": {"", "ask a question or chat"},+ "chat": {"ct", "ask a question or chat"},"changes": {"ch", "review pending changes in a TUI"},"diff": {"", "review pending changes in 'git diff' format"},"diff --plain": {"", "review pending changes in 'git diff' format with no color formatting"},diff --git a/docs/docs/cli-reference.md b/docs/docs/cli-reference.mdindex 3fbb838b..10fab961 100644--- a/docs/docs/cli-reference.md+++ b/docs/docs/cli-reference.md@@ -282,6 +282,7 @@ Ask a question or chat without making any changes.```bashplandex chat "is it clear from the context how to add a new line chart?"+pdx ct # alias````--file/-f`: File path containing prompt.diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.mdindex b3f141e5..1f5ddec6 100644--- a/docs/docs/quick-start.md+++ b/docs/docs/quick-start.md@@ -15,15 +15,13 @@ curl -sL https://plandex.ai/install.sh | bashNote that Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). Plandex only works correctly on Windows in the WSL shell. It doesn't work in the Windows CMD prompt or PowerShell.-## Decide How To Use Plandex--Choose from three options:+## Hosting Options| # | Option | Description ||---|---------|--------------------------------|| 1 | **Plandex Cloud (Integrated Models)** | No separate accounts or API keys are required. This is the quickest way to get started. If you choose this option, skip ahead to the [Create A Plan](#create-a-plan) section below. || 2 | **Plandex Cloud (BYO API Key)** | You'll need accounts and API keys for [OpenRouter.ai](https://openrouter.ai) and [OpenAI](https://platform.openai.com) to get started with the default models. |-| 3 | **Self-hosted** | First, follow the [self-hosting guide](./hosting/self-hosting.md) to set up your own Plandex server. You'll also need accounts and API keys for [OpenRouter.ai](https://openrouter.ai) and [OpenAI](https://platform.openai.com) to get started with the default models. |+| 3 | **Self-Hosted** | First, follow the [self-hosting guide](./hosting/self-hosting.md) to set up your own Plandex server. You'll also need accounts and API keys for [OpenRouter.ai](https://openrouter.ai) and [OpenAI](https://platform.openai.com) to get started with the default models. |If you're going with option 2 or 3 above, you'll need to set the `OPENROUTER_API_KEY` and `OPENAI_API_KEY` environment variables before continuing:@@ -192,7 +190,7 @@ Here are the same commands we went through above using aliases to minimize typinpdx newpdx l some-file.ts another-file.ts # loadpdx t -f prompt.txt # tell-plandex chat "is it clear from the context how to add a new line chart?"+pdx ct "is it clear from the context how to add a new line chart?" # chatpdx diffpdx diff --uipdx log