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 β Add comprehensive documentation including Introduction, Installation, Core Concepts, Advanced Topics, CLI Reference, Common Issues, and Tips and Tricks
Dane Schneider128238955412
diff --git a/docs/docs/advanced-topics/_category_.json b/docs/docs/advanced-topics/_category_.jsonnew file mode 100644index 00000000..000e7008--- /dev/null+++ b/docs/docs/advanced-topics/_category_.json@@ -0,0 +1,11 @@+{+ "label": "Advanced Topics",+ "position": 5,+ "collapsible": false,+ "items": [+ "advanced-topics/model-settings",+ "advanced-topics/custom-models",+ "advanced-topics/self-hosting",+ "advanced-topics/security-and-privacy"+ ]+}diff --git a/docs/docs/advanced-topics/custom-models.md b/docs/docs/advanced-topics/custom-models.mdnew file mode 100644index 00000000..80e7cca8--- /dev/null+++ b/docs/docs/advanced-topics/custom-models.md@@ -0,0 +1,47 @@+# Custom Models++Plandex allows you to add and manage custom models to tailor the AI's behavior to your specific needs.++## Adding a Custom Model++To add a custom model, use the `plandex models add` command:++```bash+plandex models add+```++Follow the prompts to provide the necessary details for the custom model, such as the provider, model name, base URL, API key environment variable, and other settings.++## Deleting a Custom Model++To delete a custom model, use the `plandex models delete` command:++```bash+plandex models delete model-name+```++You can also delete a custom model by its index in the list of custom models:++```bash+plandex models delete 1+```++## Listing Custom Models++To list all custom models, use the `plandex models available --custom` command:++```bash+plandex models available --custom+```++This will display a list of all custom models that you have added.++## Using Custom Models++Once you have added a custom model, you can use it in your plans by setting it as the model for a specific role. For example, to set a custom model as the planner model, use the `plandex set-model` command:++```bash+plandex set-model planner custom-provider/model-name+```++You can also set custom models for other roles, such as builder, namer, and verifier, using the same command.diff --git a/docs/docs/advanced-topics/model-settings.md b/docs/docs/advanced-topics/model-settings.mdnew file mode 100644index 00000000..27617f64--- /dev/null+++ b/docs/docs/advanced-topics/model-settings.md@@ -0,0 +1,42 @@+# Model Settings++Plandex offers a wide range of model settings that allow you to customize the behavior of the AI.++## Viewing Model Settings++To view the current model settings, use the `plandex models` command:++```bash+plandex models+```++## Changing Model Settings++To change the model settings, use the `plandex set-model` command:++```bash+plandex set-model planner openai/gpt-4+```++## Default Model Settings++To view and change the default model settings for new plans, use the `plandex models default` and `plandex set-model default` commands:++```bash+plandex models default+plandex set-model default planner openai/gpt-4+```++## Custom Models++You can add custom models using the `plandex models add` command:++```bash+plandex models add+```++To delete a custom model, use the `plandex models delete` command:++```bash+plandex models delete+```diff --git a/docs/docs/advanced-topics/security-and-privacy.md b/docs/docs/advanced-topics/security-and-privacy.mdnew file mode 100644index 00000000..b6860bd2--- /dev/null+++ b/docs/docs/advanced-topics/security-and-privacy.md@@ -0,0 +1,42 @@+# Security and Privacy++Plandex takes security and privacy seriously. This document outlines the security measures and privacy policies in place for Plandex.++## Security++### Network and Data Security++Plandex Cloud follows best practices for network and data security. Data is encrypted in transit and at rest. The database runs within a private, hardened network.++### API Key Security++Plandex is a bring-your-own-API-key tool. On the Plandex server, whether that's Plandex Cloud or a self-hosted server, API keys are only stored ephemerally in RAM while they are in active use. They are never written to disk, logged, or stored in a database. As soon as a plan stream ends, the API key is removed from memory and no longer exists anywhere on our servers.++### Ignoring Sensitive Files++Plandex respects `.gitignore` and won't load any files that you're ignoring. You can also add a `.plandexignore` file with ignore patterns to any directory.++## Privacy++### Plandex Cloud++Data you send to Plandex Cloud is retained in order to debug and improve Plandex. In the future, this data may also be used to train and fine-tune models to improve performance.++If you delete a plan or delete your Plandex Cloud account, all associated data will be removed. It will still be included in backups for up to 7 days, then it will no longer exist anywhere on Plandex Cloud.++### Third Party Services++Data sent to Plandex Cloud may be shared with the following third parties:++- AWS for hosting and database services. Data is encrypted in transit and at rest.+- In the future, your name and email may be shared with a third party transactional email service and/or email marketing service to send you information about your account or updates on Plandex. You will be able to opt out of these emails at any time.+- When billing and payments are implemented, your name and email may be shared with our payment processor Stripe.+- In the future, your name, email, and metadata on the actions you take with Plandex may be shared with a third party analytics service to track usage and make improvements.++Apart from the above list, no other data will be shared with any other third party. The list will be updated when a specific third party is chosen for any of the above services, or if any new third party services are introduced.++Data sent to a model provider like OpenAI is subject to the model provider's privacy and data retention policies.++### Self-Hosting++If you self-host Plandex, no data will be sent to Plandex Cloud or to any third party, except for the data you send to model providers like OpenAI.diff --git a/docs/docs/advanced-topics/self-hosting.md b/docs/docs/advanced-topics/self-hosting.mdnew file mode 100644index 00000000..13ad76b5--- /dev/null+++ b/docs/docs/advanced-topics/self-hosting.md@@ -0,0 +1,111 @@+# Self-Hosting++Plandex can be self-hosted for greater control and customization. Follow these steps to set up a self-hosted Plandex server.++## Quick Start Script++To quickly set up a self-hosted Plandex server, run the following commands:++```bash+git clone https://github.com/plandex-ai/plandex.git+cd plandex/app+./start_local.sh+```++## Requirements++The Plandex server requires a PostgreSQL database (ideally v14), a persistent file system, git, and the following environment variables:++```bash+export DATABASE_URL=postgres://user:password@host:5432/plandex+export GOENV=production+export SMTP_HOST=smtp.example.com+export SMTP_PORT=587+export SMTP_USER=user+export SMTP_PASSWORD=password+export [email protected] # optional, if not set then SMTP_USER is used+```++## Using Docker Build++To run the Plandex server from a Dockerfile, follow these steps:++```bash+git clone https://github.com/plandex-ai/plandex.git+VERSION=$(cat app/server/version.txt) # or use the version you want+git checkout server/v$VERSION+cd plandex/app+mkdir ~/plandex-server # or another directory where you want to store files+docker build -t plandex-server -f Dockerfile.server .+docker run -p 8080:8080 \+ -v ~/plandex-server:/plandex-server \+ -e DATABASE_URL \+ -e GOENV \+ -e SMTP_HOST \+ -e SMTP_PORT \+ -e SMTP_USER \+ -e SMTP_PASSWORD \+ plandex-server+```++## Using Docker Compose++If you don't have a PostgreSQL server, you can use the `docker-compose.yml` file:++```bash+cd plandex/app+cp _env .env+# edit .env to set the required environment variables for postgres+docker compose build+docker compose up+```++## Running from Source++To run the Plandex server from source, follow these steps:++```bash+git clone https://github.com/plandex-ai/plandex.git+cd plandex/+VERSION=$(cat app/server/version.txt) # or use the version you want+git checkout server/v$VERSION+cd app/server+export PLANDEX_BASE_DIR=~/plandex-server # or another directory where you want to store files+go run main.go+```++## Development Mode++In development mode, authentication tokens will be copied to the clipboard instead of sent via email, and a system notification will pop up to let you know that the token is ready to paste. The pin will also be output to the console.++To set up development mode, set the following environment variable:++```bash+export GOENV=development+```++## Health Check++You can check if the server is running by sending a GET request to `/health`. If all is well, it will return a 200 status code.++## Creating a New Account++Once the server is running, you can create a new account by running the `plandex sign-in` command on your local machine:++```bash+plandex sign-in+```++## Local CLI Files++If you reset the database or use a new one, you'll need to remove the local files that the CLI creates in directories where you used Plandex to start fresh. Remove the following in any directory you used the CLI in:++- `.plandex-dev` directory if you ran the CLI with `PLANDEX_ENV=development`+- `.plandex` directory otherwise++Then run `plandex sign-in` again to create a new account.++If you're still having trouble with accounts, you can also remove the following from your $HOME directory to fully reset them:++- `.plandex-home-dev` directory if you ran the CLI with `PLANDEX_ENV=development`+- `.plandex-home` directory otherwisediff --git a/docs/docs/cli-reference/_category_.json b/docs/docs/cli-reference/_category_.jsonnew file mode 100644index 00000000..ffd0cd96--- /dev/null+++ b/docs/docs/cli-reference/_category_.json@@ -0,0 +1,10 @@+{+ "label": "CLI Reference",+ "position": 6,+ "collapsible": false,+ "items": [+ "cli-reference/command-list",+ "cli-reference/detailed-command-usage",+ "cli-reference/aliases-and-shortcuts"+ ]+}diff --git a/docs/docs/cli-reference/aliases-and-shortcuts.md b/docs/docs/cli-reference/aliases-and-shortcuts.mdnew file mode 100644index 00000000..03c0fd07--- /dev/null+++ b/docs/docs/cli-reference/aliases-and-shortcuts.md@@ -0,0 +1,61 @@+# Aliases and Shortcuts++Plandex provides several aliases and shortcuts to make it easier to use the CLI.++## `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command. The alias is automatically set up during installation.++```bash+pdx --version+```++This should print the version number of Plandex.++## Command Aliases++Many Plandex commands have shorter aliases to save time and keystrokes. Here is a list of commands and their aliases:++- `plandex new` β `pdx n`+- `plandex load` β `pdx l`+- `plandex tell` β `pdx t`+- `plandex changes` β `pdx ch`+- `plandex diff` β `pdx diff`+- `plandex apply` β `pdx ap`+- `plandex reject` β `pdx rj`+- `plandex plans` β `pdx pl`+- `plandex cd` β `pdx cd`+- `plandex current` β `pdx cu`+- `plandex delete-plan` β `pdx dp`+- `plandex rename` β `pdx rename`+- `plandex archive` β `pdx arc`+- `plandex unarchive` β `pdx unarc`+- `plandex ls` β `pdx ls`+- `plandex rm` β `pdx rm`+- `plandex update` β `pdx u`+- `plandex clear` β `pdx clear`+- `plandex branches` β `pdx br`+- `plandex checkout` β `pdx co`+- `plandex delete-branch` β `pdx db`+- `plandex log` β `pdx log`+- `plandex rewind` β `pdx rw`+- `plandex convo` β `pdx convo`+- `plandex ps` β `pdx ps`+- `plandex connect` β `pdx conn`+- `plandex stop` β `pdx s`+- `plandex models` β `pdx models`+- `plandex models default` β `pdx models default`+- `plandex models available` β `pdx models avail`+- `plandex set-model` β `pdx set-model`+- `plandex set-model default` β `pdx set-model default`+- `plandex models add` β `pdx models add`+- `plandex models delete` β `pdx models delete`+- `plandex model-packs` β `pdx model-packs`+- `plandex model-packs create` β `pdx model-packs create`+- `plandex model-packs delete` β `pdx model-packs delete`+- `plandex sign-in` β `pdx sign-in`+- `plandex invite` β `pdx invite`+- `plandex revoke` β `pdx revoke`+- `plandex users` β `pdx users`++Using these aliases can save you time and make it easier to work with Plandex.diff --git a/docs/docs/cli-reference/command-list.md b/docs/docs/cli-reference/command-list.mdnew file mode 100644index 00000000..ef70e08f--- /dev/null+++ b/docs/docs/cli-reference/command-list.md@@ -0,0 +1,68 @@+# Command List++This section provides a comprehensive list of all Plandex CLI commands.++## General 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.++## Plan Management++- `plandex plans`: List plans.+- `plandex cd`: Set current plan by name or index.+- `plandex current`: Show current plan.+- `plandex delete-plan`: Delete a plan by name or index.+- `plandex rename`: Rename the current plan.+- `plandex archive`: Archive a plan.+- `plandex unarchive`: Unarchive a plan.++## Context Management++- `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.++## Branch Management++- `plandex branches`: List plan branches.+- `plandex checkout`: Checkout or create a branch.+- `plandex delete-branch`: Delete a branch by name or index.++## History and Rewind++- `plandex log`: Show plan history.+- `plandex rewind`: Rewind to a previous state.+- `plandex convo`: Show plan conversation.++## Background Tasks++- `plandex ps`: List active and recently finished plan streams.+- `plandex connect`: Connect to an active plan stream.+- `plandex stop`: Stop an active plan stream.++## Model Management++- `plandex models`: Show 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.++## Account Management++- `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 org.diff --git a/docs/docs/cli-reference/detailed-command-usage.md b/docs/docs/cli-reference/detailed-command-usage.mdnew file mode 100644index 00000000..c523dbb2--- /dev/null+++ b/docs/docs/cli-reference/detailed-command-usage.md@@ -0,0 +1,365 @@+# Detailed Command Usage++This section provides detailed explanations and examples for each Plandex CLI command.++## General Commands++### `plandex new`++Start a new plan.++```bash+plandex new+```++You can also name your plan:++```bash+plandex new -n my-plan+```++### `plandex load`++Load files, directories, URLs, notes, or piped data into context.++```bash+plandex load file1.ts file2.ts+plandex load src -r # Load a directory recursively+plandex load https://example.com/docs+plandex load -n "This is a note."+```++### `plandex tell`++Describe a task, ask a question, or chat.++```bash+plandex tell "Add a new feature to the project."+plandex tell -f prompt.txt # Load a prompt from a file+```++### `plandex changes`++Review pending changes in a TUI.++```bash+plandex changes+```++### `plandex diff`++Review pending changes in 'git diff' format.++```bash+plandex diff+```++### `plandex apply`++Apply pending changes to project files.++```bash+plandex apply+```++### `plandex reject`++Reject pending changes to one or more project files.++```bash+plandex reject file1.ts+plandex reject --all # Reject all pending changes+```++## Plan Management++### `plandex plans`++List plans.++```bash+plandex plans+```++### `plandex cd`++Set current plan by name or index.++```bash+plandex cd my-plan+plandex cd 1 # Set current plan by index+```++### `plandex current`++Show current plan.++```bash+plandex current+```++### `plandex delete-plan`++Delete a plan by name or index.++```bash+plandex delete-plan my-plan+plandex delete-plan 1 # Delete plan by index+```++### `plandex rename`++Rename the current plan.++```bash+plandex rename new-name+```++### `plandex archive`++Archive a plan.++```bash+plandex archive my-plan+```++### `plandex unarchive`++Unarchive a plan.++```bash+plandex unarchive my-plan+```++## Context Management++### `plandex ls`++List everything in context.++```bash+plandex ls+```++### `plandex rm`++Remove context by index, range, name, or glob.++```bash+plandex rm file1.ts+plandex rm 1 # Remove by index+plandex rm 1-3 # Remove a range of indices+```++### `plandex update`++Update outdated context.++```bash+plandex update+```++### `plandex clear`++Remove all context.++```bash+plandex clear+```++## Branch Management++### `plandex branches`++List plan branches.++```bash+plandex branches+```++### `plandex checkout`++Checkout or create a branch.++```bash+plandex checkout new-branch+plandex checkout existing-branch+```++### `plandex delete-branch`++Delete a branch by name or index.++```bash+plandex delete-branch branch-name+plandex delete-branch 1 # Delete branch by index+```++## History and Rewind++### `plandex log`++Show plan history.++```bash+plandex log+```++### `plandex rewind`++Rewind to a previous state.++```bash+plandex rewind 3 # Rewind 3 steps+plandex rewind a7c8d66 # Rewind to a specific commit+```++### `plandex convo`++Show plan conversation.++```bash+plandex convo+```++## Background Tasks++### `plandex ps`++List active and recently finished plan streams.++```bash+plandex ps+```++### `plandex connect`++Connect to an active plan stream.++```bash+plandex connect+```++### `plandex stop`++Stop an active plan stream.++```bash+plandex stop+```++## Model Management++### `plandex models`++Show plan model settings.++```bash+plandex models+```++### `plandex models default`++Show org-wide default model settings for new plans.++```bash+plandex models default+```++### `plandex models available`++Show all available models.++```bash+plandex models available+```++### `plandex set-model`++Update current plan model settings.++```bash+plandex set-model planner openai/gpt-4+```++### `plandex set-model default`++Update org-wide default model settings for new plans.++```bash+plandex set-model default planner openai/gpt-4+```++### `plandex models add`++Add a custom model.++```bash+plandex models add+```++### `plandex models delete`++Delete a custom model.++```bash+plandex models delete model-name+```++### `plandex model-packs`++Show all available model packs.++```bash+plandex model-packs+```++### `plandex model-packs create`++Create a new custom model pack.++```bash+plandex model-packs create+```++### `plandex model-packs delete`++Delete a custom model pack.++```bash+plandex model-packs delete model-pack-name+```++## Account Management++### `plandex sign-in`++Sign in, accept an invite, or create an account.++```bash+plandex sign-in+```++### `plandex invite`++Invite a user to join your org.++```bash+plandex invite [email protected]+```++### `plandex revoke`++Revoke an invite or remove a user from your org.++```bash+plandex revoke [email protected]+```++### `plandex users`++List users and pending invites in your org.++```bash+plandex users+```diff --git a/docs/docs/core-concepts/_category_.json b/docs/docs/core-concepts/_category_.jsonnew file mode 100644index 00000000..879e2c08--- /dev/null+++ b/docs/docs/core-concepts/_category_.json@@ -0,0 +1,12 @@+{+ "label": "Core Concepts",+ "position": 4,+ "collapsible": false,+ "items": [+ "core-concepts/plans",+ "core-concepts/context-management",+ "core-concepts/branches",+ "core-concepts/rewind-and-history",+ "core-concepts/background-tasks"+ ]+}diff --git a/docs/docs/core-concepts/background-tasks.md b/docs/docs/core-concepts/background-tasks.mdnew file mode 100644index 00000000..dd7c9663--- /dev/null+++ b/docs/docs/core-concepts/background-tasks.md@@ -0,0 +1,35 @@+# Background Tasks++Plandex allows you to run tasks in the background, enabling you to work on multiple tasks in parallel.++## Running a Task in the Background++To run a task in the background, use the `--bg` flag:++```bash+plandex tell --bg "Add a new feature"+```++## Listing Background Tasks++To list active and recently finished background tasks, use the `plandex ps` command:++```bash+plandex ps+```++## Connecting to a Background Task++To connect to a running background task, use the `plandex connect` command:++```bash+plandex connect+```++## Stopping a Background Task++To stop a running background task, use the `plandex stop` command:++```bash+plandex stop+```diff --git a/docs/docs/core-concepts/branches.md b/docs/docs/core-concepts/branches.mdnew file mode 100644index 00000000..62e7770f--- /dev/null+++ b/docs/docs/core-concepts/branches.md@@ -0,0 +1,35 @@+# Branches++Branches in Plandex allow you to work on multiple tasks or approaches in parallel. Each branch can have its own context and changes.++## Creating a Branch++To create a new branch, use the `plandex checkout` command:++```bash+plandex checkout new-branch+```++## Switching Branches++To switch to a different branch, use the `plandex checkout` command:++```bash+plandex checkout existing-branch+```++## Listing Branches++To list all branches, use the `plandex branches` command:++```bash+plandex branches+```++## Deleting a Branch++To delete a branch, use the `plandex delete-branch` command:++```bash+plandex delete-branch branch-name+```diff --git a/docs/docs/core-concepts/context-management.md b/docs/docs/core-concepts/context-management.mdnew file mode 100644index 00000000..e144a2a8--- /dev/null+++ b/docs/docs/core-concepts/context-management.md@@ -0,0 +1,44 @@+# Context Management++Context in Plandex refers to the files, directories, URLs, and other data that the AI uses to understand and work on your project.++## Loading Context++To load files or directories into context, use the `plandex load` command:++```bash+plandex load file1.ts file2.ts+plandex load src -r # Load a directory recursively+```++## Viewing Context++To list everything in context, use the `plandex ls` command:++```bash+plandex ls+```++## Removing Context++To remove context, use the `plandex rm` command:++```bash+plandex rm file1.ts+```++## Clearing Context++To clear all context, use the `plandex clear` command:++```bash+plandex clear+```++## Updating Context++To update outdated context, use the `plandex update` command:++```bash+plandex update+```diff --git a/docs/docs/core-concepts/plans.md b/docs/docs/core-concepts/plans.mdnew file mode 100644index 00000000..a67405e6--- /dev/null+++ b/docs/docs/core-concepts/plans.md@@ -0,0 +1,63 @@+# Plans++A plan in Plandex is a structured task that the AI will work on. Plans help you organize and manage your development tasks efficiently.++## Creating a Plan++To create a new plan, use the `plandex new` command:++```bash+plandex new+```++You can also name your plan:++```bash+plandex new -n my-plan+```++## Viewing the Current Plan++To see the current plan, use the `plandex current` command:++```bash+plandex current+```++## Switching Plans++To switch to a different plan, use the `plandex cd` command:++```bash+plandex cd my-plan+```++## Listing Plans++To list all plans, use the `plandex plans` command:++```bash+plandex plans+```++## Deleting a Plan++To delete a plan, use the `plandex delete-plan` command:++```bash+plandex delete-plan my-plan+```++## Archiving and Unarchiving Plans++To archive a plan, use the `plandex archive` command:++```bash+plandex archive my-plan+```++To unarchive a plan, use the `plandex unarchive` command:++```bash+plandex unarchive my-plan+```diff --git a/docs/docs/core-concepts/rewind-and-history.md b/docs/docs/core-concepts/rewind-and-history.mdnew file mode 100644index 00000000..dba06483--- /dev/null+++ b/docs/docs/core-concepts/rewind-and-history.md@@ -0,0 +1,28 @@+# Rewind and History++Plandex allows you to rewind to a previous state and view the history of your plan.++## Rewinding++To rewind the plan to an earlier state, use the `plandex rewind` command:++```bash+plandex rewind 3 # Rewind 3 steps+plandex rewind a7c8d66 # Rewind to a specific commit+```++## Viewing History++To view the history of your plan, use the `plandex log` command:++```bash+plandex log+```++## Viewing Conversation++To view the conversation history, use the `plandex convo` command:++```bash+plandex convo+```diff --git a/docs/docs/faq-and-troubleshooting/_category_.json b/docs/docs/faq-and-troubleshooting/_category_.jsonnew file mode 100644index 00000000..7c377751--- /dev/null+++ b/docs/docs/faq-and-troubleshooting/_category_.json@@ -0,0 +1,9 @@+{+ "label": "FAQ and Troubleshooting",+ "position": 7,+ "collapsible": false,+ "items": [+ "faq-and-troubleshooting/common-issues",+ "faq-and-troubleshooting/tips-and-tricks"+ ]+}diff --git a/docs/docs/faq-and-troubleshooting/common-issues.md b/docs/docs/faq-and-troubleshooting/common-issues.mdnew file mode 100644index 00000000..111f1abb--- /dev/null+++ b/docs/docs/faq-and-troubleshooting/common-issues.md@@ -0,0 +1,47 @@+# Common Issues++This section addresses common issues that users may encounter while using Plandex and provides solutions to resolve them.++## Installation Issues++### Problem: Installation Fails++**Solution**: Ensure you have the necessary permissions to install software on your system. If you are using a Unix-based system, try running the installation command with `sudo`:++```bash+sudo curl -sL https://plandex.ai/install.sh | bash+```++### Problem: Command Not Found++**Solution**: Ensure that the directory where Plandex is installed is in your `PATH`. You can add it to your `PATH` by adding the following line to your shell configuration file (e.g., `.bashrc`, `.zshrc`):++```bash+export PATH=$PATH:/path/to/plandex+```++## Context Management Issues++### Problem: Context Not Loading++**Solution**: Ensure that the files or directories you are trying to load exist and are accessible. Check for any typos in the file or directory names. Use the `plandex ls` command to verify the current context.++## Plan Management Issues++### Problem: Unable to Create a New Plan++**Solution**: Ensure that you are in the correct directory and have the necessary permissions to create files. Use the `plandex new` command to create a new plan.++## Model Management Issues++### Problem: Custom Model Not Working++**Solution**: Ensure that the custom model is compatible with Plandex and that you have provided the correct details during the setup. Use the `plandex models available --custom` command to list all custom models and verify their details.++## General Issues++### Problem: Command Not Working as Expected++**Solution**: Ensure that you are using the correct syntax and options for the command. Refer to the [CLI Reference](../cli-reference/command-list.md) for detailed usage instructions.++If you continue to experience issues, please reach out to the Plandex support team for further assistance.diff --git a/docs/docs/faq-and-troubleshooting/tips-and-tricks.md b/docs/docs/faq-and-troubleshooting/tips-and-tricks.mdnew file mode 100644index 00000000..aaadb8b3--- /dev/null+++ b/docs/docs/faq-and-troubleshooting/tips-and-tricks.md@@ -0,0 +1,112 @@+# Tips and Tricks++This section provides useful tips and tricks to help you get the most out of Plandex.++## Using the `pdx` Alias++For convenience, use the `pdx` alias instead of typing `plandex` for every command. The alias is automatically set up during installation.++```bash+pdx --version+```++## Efficient Context Management++### Loading Multiple Files++You can load multiple files into context at once:++```bash+plandex load file1.ts file2.ts+```++### Loading Directories Recursively++To load a directory and its subdirectories, use the `-r` flag:++```bash+plandex load src -r+```++### Adding Notes++You can add notes to the context to provide additional information:++```bash+plandex load -n "This is a note."+```++## Managing Plans and Branches++### Creating and Switching Plans++Create a new plan and switch to it:++```bash+plandex new -n my-plan+plandex cd my-plan+```++### Creating and Switching Branches++Create a new branch and switch to it:++```bash+plandex checkout new-branch+```++## Reviewing and Applying Changes++### Reviewing Changes++Use the `plandex changes` command to review pending changes in a TUI:++```bash+plandex changes+```++### Applying Changes++Apply pending changes to your project files:++```bash+plandex apply+```++## Using Background Tasks++### Running Tasks in the Background++Run a task in the background using the `--bg` flag:++```bash+plandex tell --bg "Add a new feature"+```++### Listing Background Tasks++List active and recently finished background tasks:++```bash+plandex ps+```++## Customizing Model Settings++### Viewing Model Settings++View the current model settings:++```bash+plandex models+```++### Changing Model Settings++Change the model settings:++```bash+plandex set-model planner openai/gpt-4+```++By following these tips and tricks, you can use Plandex more efficiently and effectively.diff --git a/docs/docs/getting-started/_category_.json b/docs/docs/getting-started/_category_.jsonnew file mode 100644index 00000000..fba78eb4--- /dev/null+++ b/docs/docs/getting-started/_category_.json@@ -0,0 +1,11 @@+{+ "label": "Getting Started",+ "position": 3,+ "collapsible": false,+ "items": [+ "getting-started/creating-a-new-plan",+ "getting-started/loading-context",+ "getting-started/sending-prompts",+ "getting-started/reviewing-and-applying-changes"+ ]+}diff --git a/docs/docs/getting-started/creating-a-new-plan.md b/docs/docs/getting-started/creating-a-new-plan.mdnew file mode 100644index 00000000..b26f33ea--- /dev/null+++ b/docs/docs/getting-started/creating-a-new-plan.md@@ -0,0 +1,29 @@+# Creating a New Plan++To create a new plan in your project's root directory, use the `plandex new` command:++```bash+plandex new+```++This command will start a new plan and set it as the current plan.++## Naming Your Plan++You can also give your plan a name up front:++```bash+plandex new -n my-plan+```++If you don't provide a name, the plan will be named 'draft' until you give it a task.++## Verifying the Current Plan++To see the current plan, use the `plandex current` command:++```bash+plandex current+```++This will display the name and details of the current plan.diff --git a/docs/docs/getting-started/loading-context.md b/docs/docs/getting-started/loading-context.mdnew file mode 100644index 00000000..7987b684--- /dev/null+++ b/docs/docs/getting-started/loading-context.md@@ -0,0 +1,44 @@+# Loading Context++After creating a plan, load any relevant files, directories, URLs, or other data into the plan context.++## Loading Files and Directories++To load files or directories into context, use the `plandex load` command:++```bash+plandex load file1.ts file2.ts+plandex load src -r # Load a directory recursively+```++## Loading URLs++You can also load the content of a URL into context:++```bash+plandex load https://example.com/docs+```++## Loading Notes++To add a note to the context, use the `-n` flag:++```bash+plandex load -n "This is a note."+```++## Loading Images++Plandex supports loading images (PNG, JPEG, non-animated GIF, and WebP formats):++```bash+plandex load image.png+```++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command:++```bash+pdx load file1.ts file2.ts+```diff --git a/docs/docs/getting-started/reviewing-and-applying-changes.md b/docs/docs/getting-started/reviewing-and-applying-changes.mdnew file mode 100644index 00000000..eed124dd--- /dev/null+++ b/docs/docs/getting-started/reviewing-and-applying-changes.md@@ -0,0 +1,32 @@+# Reviewing and Applying Changes++Plandex will stream the response to your terminal and build up a set of changes along the way. You can review and apply these changes to your project files.++## Reviewing Changes++To review the changes that Plandex has built up so far, use the `plandex changes` command:++```bash+plandex changes+```++This will open a user-friendly TUI changes viewer.++## Applying Changes++If you're happy with the changes, apply them to your files:++```bash+plandex apply+```++If you're in a git repo, Plandex will automatically add a commit with a nicely formatted message describing the changes. Any uncommitted changes that were present in your working directory beforehand will be unaffected.++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command:++```bash+pdx changes+pdx apply+```diff --git a/docs/docs/getting-started/sending-prompts.md b/docs/docs/getting-started/sending-prompts.mdnew file mode 100644index 00000000..bd5a880c--- /dev/null+++ b/docs/docs/getting-started/sending-prompts.md@@ -0,0 +1,27 @@+# Sending Prompts++After loading context, you can send a prompt to Plandex to describe a task, ask a question, or chat.++## Sending a Prompt++To send a prompt, use the `plandex tell` command:++```bash+plandex tell "Add a new feature to the project."+```++## Using a File++You can also load a prompt from a file:++```bash+plandex tell -f prompt.txt+```++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command:++```bash+pdx tell "Add a new feature to the project."+```diff --git a/docs/docs/installation/_category_.json b/docs/docs/installation/_category_.jsonnew file mode 100644index 00000000..70f8bb14--- /dev/null+++ b/docs/docs/installation/_category_.json@@ -0,0 +1,11 @@+{+ "label": "Installation",+ "position": 2,+ "collapsible": false,+ "items": [+ "installation/quick-install",+ "installation/manual-install",+ "installation/build-from-source",+ "installation/windows-install"+ ]+}diff --git a/docs/docs/installation/build-from-source.md b/docs/docs/installation/build-from-source.mdnew file mode 100644index 00000000..344e73a5--- /dev/null+++ b/docs/docs/installation/build-from-source.md@@ -0,0 +1,63 @@+# Build from Source++To build Plandex from source, follow these steps:++1. Clone the Plandex repository:++```bash+git clone https://github.com/plandex-ai/plandex.git+```++2. Clone the Survey repository:++```bash+git clone https://github.com/plandex-ai/survey.git+```++3. Navigate to the CLI directory:++```bash+cd plandex/app/cli+```++4. Build the CLI:++```bash+go build -ldflags "-X plandex/version.Version=$(cat version.txt)"+```++5. Move the binary to a directory in your `PATH`. For example:++```bash+mv plandex /usr/local/bin+```++6. Verify the installation by running:++```bash+plandex --version+```++You should see the version number of Plandex printed in the terminal.++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command. You can set up the alias manually by adding the following line to your shell configuration file (e.g., `.bashrc`, `.zshrc`):++```bash+alias pdx='plandex'+```++After adding the alias, reload your shell configuration:++```bash+source ~/.bashrc # or source ~/.zshrc+```++Now you can use the `pdx` alias:++```bash+pdx --version+```++This should also print the version number of Plandex.diff --git a/docs/docs/installation/manual-install.md b/docs/docs/installation/manual-install.mdnew file mode 100644index 00000000..44fa0bd6--- /dev/null+++ b/docs/docs/installation/manual-install.md@@ -0,0 +1,40 @@+# Manual Install++If you prefer to install Plandex manually, follow these steps:++1. Download the appropriate binary for your platform from the [latest release](https://github.com/plandex-ai/plandex/releases).+2. Move the binary to a directory in your `PATH`. For example:++```bash+mv plandex /usr/local/bin+```++3. Verify the installation by running:++```bash+plandex --version+```++You should see the version number of Plandex printed in the terminal.++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command. You can set up the alias manually by adding the following line to your shell configuration file (e.g., `.bashrc`, `.zshrc`):++```bash+alias pdx='plandex'+```++After adding the alias, reload your shell configuration:++```bash+source ~/.bashrc # or source ~/.zshrc+```++Now you can use the `pdx` alias:++```bash+pdx --version+```++This should also print the version number of Plandex.diff --git a/docs/docs/installation/quick-install.md b/docs/docs/installation/quick-install.mdnew file mode 100644index 00000000..e02f413a--- /dev/null+++ b/docs/docs/installation/quick-install.md@@ -0,0 +1,29 @@+# Quick Install++To quickly install Plandex, run the following command in your terminal:++```bash+curl -sL https://plandex.ai/install.sh | bash+```++This command will download and install the latest version of Plandex.++## Verify Installation++After installation, you can verify that Plandex is installed correctly by running:++```bash+plandex --version+```++You should see the version number of Plandex printed in the terminal.++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command. The alias is automatically set up during installation.++```bash+pdx --version+```++This should also print the version number of Plandex.diff --git a/docs/docs/installation/windows-install.md b/docs/docs/installation/windows-install.mdnew file mode 100644index 00000000..91eca1d3--- /dev/null+++ b/docs/docs/installation/windows-install.md@@ -0,0 +1,47 @@+# Windows Installation (WSL)++Plandex requires the Windows Subsystem for Linux (WSL) to run on Windows. Follow these steps to install Plandex on Windows:++## Install WSL++1. Open PowerShell as Administrator and run the following command to install WSL:++```powershell+wsl --install+```++2. Restart your computer if prompted.++3. Set up your Linux distribution by following the on-screen instructions.++## Install Plandex++1. Open your WSL terminal (e.g., Ubuntu).++2. Run the following command to install Plandex:++```bash+curl -sL https://plandex.ai/install.sh | bash+```++3. Verify the installation by running:++```bash+plandex --version+```++You should see the version number of Plandex printed in the terminal.++## Using the `pdx` Alias++For convenience, you can use the `pdx` alias instead of typing `plandex` for every command. The alias is automatically set up during installation.++```bash+pdx --version+```++This should also print the version number of Plandex.++## Note++Plandex will not work in the Windows CMD shell. You must use the WSL terminal to run Plandex commands.diff --git a/docs/docs/introduction/_category_.json b/docs/docs/introduction/_category_.jsonnew file mode 100644index 00000000..efa9cc56--- /dev/null+++ b/docs/docs/introduction/_category_.json@@ -0,0 +1,10 @@+{+ "label": "Introduction",+ "position": 1,+ "collapsible": false,+ "items": [+ "introduction/overview",+ "introduction/key-features",+ "introduction/use-cases"+ ]+}diff --git a/docs/docs/introduction/key-features.md b/docs/docs/introduction/key-features.mdnew file mode 100644index 00000000..012579e4--- /dev/null+++ b/docs/docs/introduction/key-features.md@@ -0,0 +1,21 @@+# Key Features++## AI-driven Development++Plandex leverages AI to help you build complex functionality quickly and efficiently. It can plan out and complete large tasks that span many files and steps, making it easier to work with unfamiliar technologies and get unstuck.++## Context Management++Easily manage the context in your terminal. Add files or entire directories to context and keep them updated automatically as you work, ensuring that models always have the latest state of your project.++## Version Control++Built-in version control allows you to easily go backwards and try a different approach. You can manage changes in a protected sandbox, review them before applying them to your project files, and use branches to explore multiple approaches.++## Multi-modal Support++Plandex supports text, images, and more, making it a versatile tool for various use cases. You can add images and screenshots to context, making it easier to work with visual data.++## Cross-platform Support++Plandex supports Mac, Linux, FreeBSD, and Windows (via WSL). It runs from a single binary with no dependencies, making it easy to set up and use on various platforms.diff --git a/docs/docs/introduction/overview.md b/docs/docs/introduction/overview.mdnew file mode 100644index 00000000..a324d3b0--- /dev/null+++ b/docs/docs/introduction/overview.md@@ -0,0 +1,20 @@+# Overview++Plandex is an AI-driven development tool that helps you build entire features and apps with a robust workflow. It can plan out and complete large tasks that span many files and steps, making it easier to work with unfamiliar technologies, get unstuck, and spend less time on the boring stuff.++## Key Features++- **AI-driven development**: Plandex uses AI to help you build complex functionality quickly and efficiently.+- **Context management**: Easily manage the context in your terminal, adding files or entire directories to context and keeping them updated automatically.+- **Version control**: Built-in version control allows you to easily go backwards and try a different approach.+- **Multi-modal support**: Plandex supports text, images, and more, making it a versatile tool for various use cases.++## Use Cases++- **Building new apps**: Quickly build new applications from scratch with the help of AI.+- **Adding features**: Easily add new features to existing codebases.+- **Writing tests and scripts**: Generate tests and scripts to ensure your code is robust and reliable.+- **Understanding code**: Use Plandex to understand and navigate complex codebases.+- **Fixing bugs**: Quickly identify and fix bugs in your code.++Plandex is designed for real-world use cases, helping you churn through your backlog, work with unfamiliar technologies, and get unstuck.diff --git a/docs/docs/introduction/use-cases.md b/docs/docs/introduction/use-cases.mdnew file mode 100644index 00000000..4bbdf93e--- /dev/null+++ b/docs/docs/introduction/use-cases.md@@ -0,0 +1,21 @@+# Use Cases++## Building New Apps++Quickly build new applications from scratch with the help of AI. Plandex can help you plan out and complete large tasks, making it easier to get started with new projects.++## Adding Features++Easily add new features to existing codebases. Plandex can help you understand the existing code, plan out the new feature, and implement it efficiently.++## Writing Tests and Scripts++Generate tests and scripts to ensure your code is robust and reliable. Plandex can help you write tests for your code, making it easier to maintain and improve.++## Understanding Code++Use Plandex to understand and navigate complex codebases. It can help you get a better understanding of the code, making it easier to work with unfamiliar technologies.++## Fixing Bugs++Quickly identify and fix bugs in your code. Plandex can help you find and fix bugs, making it easier to maintain and improve your codebase.