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
🤖 Plandex → Create a comprehensive documentation site for Plandex
Dane Schneider7c225cc2fc4a
diff --git a/docs/docs/advanced-topics.md b/docs/docs/advanced-topics.mdnew file mode 100644index 00000000..3b2b508a--- /dev/null+++ b/docs/docs/advanced-topics.md@@ -0,0 +1,13 @@+# Advanced Topics++## Custom Models++Plandex allows you to add custom models. You can add a custom model with `plandex models add` and list available models with `plandex models available`.++## Model Packs++Model packs allow you to switch out all roles at once. You can create a new model pack with `plandex model-packs create` and list available model packs with `plandex model-packs`.++## Self-Hosting++Plandex can be self-hosted. You can run the Plandex server from a Dockerfile or from source. For more details, see the [self-hosting guide](./guides/HOSTING.md).diff --git a/docs/docs/cli-reference.md b/docs/docs/cli-reference.mdnew file mode 100644index 00000000..a5a8db23--- /dev/null+++ b/docs/docs/cli-reference.md@@ -0,0 +1,76 @@+# CLI Reference++## Key Commands++- `plandex new`: Start a new plan+- `plandex load`: Load files, directories, URLs, notes, or piped data into context+- `plandex tell`: Describe a task, ask a question, or chat+- `plandex changes`: Review pending changes in a TUI+- `plandex diff`: Review pending changes in 'git diff' format+- `plandex apply`: Apply pending changes to project files+- `plandex reject`: Reject pending changes to one or more project files++## Plans++- `plandex new`: Start a new plan+- `plandex plans`: List plans+- `plandex cd`: Set current plan by name or index+- `plandex current`: Show current plan+- `plandex delete-plan`: Delete plan by name or index+- `plandex rename`: Rename the current plan+- `plandex archive`: Archive a plan+- `plandex plans --archived`: List archived plans+- `plandex unarchive`: Unarchive a plan++## Context++- `plandex load`: Load files, directories, URLs, notes, or piped data into context+- `plandex ls`: List everything in context+- `plandex rm`: Remove context by index, range, name, or glob+- `plandex update`: Update outdated context+- `plandex clear`: Remove all context++## Branches++- `plandex branches`: List plan branches+- `plandex checkout`: Checkout or create a branch+- `plandex delete-branch`: Delete a branch by name or index++## History++- `plandex log`: Show log of plan updates+- `plandex rewind`: Rewind to a previous state+- `plandex convo`: Show plan conversation+- `plandex convo --plain`: Show conversation in plain text++## Control++- `plandex tell`: Describe a task, ask a question, or chat+- `plandex continue`: Continue the plan+- `plandex build`: Build any pending changes++## Streams++- `plandex ps`: List active and recently finished plan streams+- `plandex connect`: Connect to an active plan stream+- `plandex stop`: Stop an active plan stream++## AI Models++- `plandex models`: Show current plan model settings+- `plandex models default`: Show org-wide default model settings for new plans+- `plandex models available`: Show all available models+- `plandex set-model`: Update current plan model settings+- `plandex set-model default`: Update org-wide default model settings for new plans+- `plandex models add`: Add a custom model+- `plandex models delete`: Delete a custom model+- `plandex model-packs`: Show all available model packs+- `plandex model-packs create`: Create a new custom model pack+- `plandex model-packs delete`: Delete a custom model pack++## Accounts++- `plandex sign-in`: Sign in, accept an invite, or create an account+- `plandex invite`: Invite a user to join your org+- `plandex revoke`: Revoke an invite or remove a user from your org+- `plandex users`: List users and pending invites in your orgdiff --git a/docs/docs/core-concepts.md b/docs/docs/core-concepts.mdnew file mode 100644index 00000000..e7423aa5--- /dev/null+++ b/docs/docs/core-concepts.md@@ -0,0 +1,17 @@+# Core Concepts++## Plans and Context++Plandex uses plans to manage tasks and context. A plan is a set of files and directories that are loaded into the AI's context. You can create a new plan with `plandex new` and load context with `plandex load`.++## Branches and Rewind++Plandex supports branches and rewinding to previous states. You can create a new branch with `plandex checkout` and rewind to a previous state with `plandex rewind`.++## Managing Changes++Plandex allows you to review and manage changes before applying them to your project files. You can view changes with `plandex changes` and apply them with `plandex apply`.++## Model Settings++Plandex supports a wide range of models and allows you to customize model settings. You can view current model settings with `plandex models` and update them with `plandex set-model`.diff --git a/docs/docs/getting-started.md b/docs/docs/getting-started.mdnew file mode 100644index 00000000..b280e6a7--- /dev/null+++ b/docs/docs/getting-started.md@@ -0,0 +1,45 @@+# Getting Started++## Creating a New Plan++First, `cd` into your project's directory. Make a new directory first with `mkdir your-project-dir` if you're starting on a new project.++```bash+cd your-project-dir+```++Then start your first plan with `plandex new`.++```bash+plandex new+```++## Loading Context++After creating a plan, load any relevant files, directories, or URLs into the plan context.++```bash+plandex load component.ts action.ts reducer.ts+plandex load lib -r # loads lib and all its subdirectories+plandex load tests/**/*.ts # loads all .ts files in tests and its subdirectories+plandex load . --tree # loads the layout of the current directory and its subdirectories (file names only)+plandex load https://redux.js.org/usage/writing-tests # loads the text-only content of the URL+npm test | plandex load # loads the output of `npm test`+plandex load -n 'add logging statements to all the code you generate.' # load a note into context+```++## Sending a Prompt++Now give the AI a task to do.++```bash+# with no arguments, vim or nano will open and you can type your task there+plandex tell+# you can pass a task directly as a string+# press enter for line breaks while inside the quotes+plandex tell 'build another component like this one that displays foo adapters in the table rather than bar adapters.+quote> use the same layout and styles, but update the column headers and formatting to match the new data.+quote> add the needed reducer and action as well. write tests for the new code.'+# load a task from a file+plandex tell --file task.txt # or -f task.txt+```diff --git a/docs/docs/installation.md b/docs/docs/installation.mdnew file mode 100644index 00000000..dd11f370--- /dev/null+++ b/docs/docs/installation.md@@ -0,0 +1,33 @@+# Installation++## Quick Install++```bash+curl -sL https://plandex.ai/install.sh | bash+```++## Manual Install++Grab the appropriate binary for your platform from the latest [release](https://github.com/plandex-ai/plandex/releases) and put it somewhere in your `PATH`.++## Build from Source++```bash+git clone https://github.com/plandex-ai/plandex.git+git clone https://github.com/plandex-ai/survey.git+cd plandex/app/cli+go build -ldflags "-X plandex/version.Version=$(cat version.txt)"+mv plandex /usr/local/bin # adapt as needed for your system+```++## Windows++Windows is supported via [WSL](https://learn.microsoft.com/en-us/windows/wsl/about). Note that Plandex won't work in the Windows CMD shell. The WSL terminal is required.++```bash+# Install WSL+wsl --install++# Install Plandex+curl -sL https://plandex.ai/install.sh | bash+```diff --git a/docs/docs/introduction.md b/docs/docs/introduction.mdnew file mode 100644index 00000000..dfd0bf5b--- /dev/null+++ b/docs/docs/introduction.md@@ -0,0 +1,12 @@+# Introduction++## Overview of Plandex++Plandex is a reliable and developer-friendly AI coding agent in your terminal. It can plan out and complete large tasks that span many files and steps. Designed for real-world use-cases, Plandex can help you build a new app quickly, add new features to an existing codebase, write tests and scripts, understand code, and fix bugs.++## Key Features++- **AI-driven development**: Build entire features and apps with a robust workflow.+- **Context management**: Efficiently manage context in the terminal.+- **Multi-model support**: Use with a wide range of models, including OpenAI, Anthropic Claude, Google Gemini, and more.+- **Cross-platform**: Supports Mac, Linux, FreeBSD, and Windows.