Skip to content

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

wip: docs

Dane Schneider96ca5ffe7ceb
diff --git a/docs/docs/intro.md b/docs/docs/intro.md
index c812630a..5db38c68 100644
--- a/docs/docs/intro.md
+++ b/docs/docs/intro.md
@@ -54,7 +54,7 @@ Plandex uses OpenAI models by default, as so far we've found them to offer the b
That said, you can also use it with a wide range of other models, including Anthropic Claude, Google Gemini, Mixtral, Llama and many more via OpenRouter.ai, Together.ai, or any other OpenAI-compatible provider.
-## Languages and platforms
+## Languages and Platforms
You can use Plandex to work with any language or framework that the underlying LLM has been trained on. For the largest models, this includes just about any language or framework you can think of, though output quality will tend to be best for those that are more popular and therefore better represented in the training data.
diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md
index fad52ece..45b25761 100644
--- a/docs/docs/quick-start.md
+++ b/docs/docs/quick-start.md
@@ -4,3 +4,146 @@ sidebar_label: Quickstart
---
# Quickstart
+
+## Set `OPENAI_API_KEY`
+
+Plandex uses OpenAI by default. If you don't have an OpenAI account, first [sign up here.](https://platform.openai.com/signup)
+
+Then [generate an API key here](https://platform.openai.com/account/api-keys) and `export` it.
+
+```bash
+export OPENAI_API_KEY=...
+```
+
+## Create A Plan
+
+Now `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 **create your first plan** with `plandex new`.
+
+```bash
+plandex new
+```
+
+## Load In Context
+
+Load any relevant files, directories, or urls **into the LLM's context** with `plandex load`.
+
+```bash
+plandex load some-file.ts another-file.ts
+plandex load src/components -r # load a whole directory
+plandex load https://raw.githubusercontent.com/plandex-ai/plandex/main/README.md
+```
+
+## Send A Prompt
+
+Now **send your prompt.** You can pass it in as a file:
+
+```bash
+plandex tell -f prompt.txt
+```
+
+Write it in vim:
+
+```bash
+plandex tell # tell with no arguments opens vim so you can write your prompt there
+```
+
+Or pass it inline (use enter for line breaks):
+
+```bash
+plandex tell "add a new line chart showing the number of foobars over time to components/charts.tsx"
+```
+
+Plandex will make a plan for your task and then implement that plan in code.
+
+**The changes won't yet be applied to your project's files.** Instead, they'll accumulate in Plandex's sandbox.
+
+## Review The Changes
+
+When Plandex has finished with your task, you can review the proposed changes with the `diff` command, which shows them in `git diff` format:
+
+```bash
+plandex diff
+```
+
+Or you can view them in Plandex's changes TUI:
+
+```bash
+plandex changes
+```
+
+## Iterate If Needed
+
+If the proposed changes have issues or need more work, you have a few options:
+
+### 1. Continue prompting.
+
+You can send another prompt to continue updating or refining the plan.
+
+```bash
+plandex tell "the line chart should be centered and have a width and height of 80% of the screen"
+```
+
+### 2. Rewind the plan.
+
+You can use `plandex rewind` to an earlier step in the plan, load in new context or update the prompt as needed, then proceed from there with another `plandex tell` or a `plandex continue` (which continues from where the plan left off).
+
+Use `plandex log` for a list of all changes in a plan. You can rewind one step by running `plandex rewind` with no arguments, go back a specific number of steps (`plandex rewind 3`), or rewind to a specific change with a hash `plandex rewind e7e06e0`.
+
+Seeing the conversation history can also be helpful when rewinding, since `plandex log` doesn't include conversation messages in its output. You can do that with `plandex convo`.
+
+### 3. Reject incorrect files.
+
+While we're working hard to get file updates as reliable as possible, bad updates can still happen. If a plan is correct but it was applied incorrectly to a file, you can either [apply the changes](#apply-the-changes) and then fix the problems manually, *or* you can reject the updates to that file and then make the proposed changes yourself manually.
+
+To reject changes to a file (or multiple files), you can run `plandex reject` with the file path(s):
+
+```bash
+plandex reject components/charts.tsx
+```
+
+You can also reject changes using the `r` hotkey in the `plandex changes` TUI.
+
+Once the bad update is rejected, copy the changes from the plan's output or run `plandex convo` to output the full conversation and copy them from there. Then apply the updates to that file yourself.
+
+## Apply The Changes
+
+Once you're happy with the plan's changes, you can apply them to your project files with `plandex apply`:
+
+```bash
+plandex apply
+```
+
+If you're in a git repository, Plandex will give you the option of grouping the changes into a git commit with an automatically generated commit message.
+
+You've now experienced the core workflow of Plandex! While there are more commands and options available, those described above are what you'll be using most often.
+
+## CLI Help
+
+After any plandex command is run, commands that could make sense to run next will be suggested. You can learn to use Plandex quickly by jumping in and following these suggestions.
+
+You can get help on the CLI with `plandex help` and a list of all commands with `plandex help --all`. Get help on a specific command and its options with `plandex [command] --help`.
+
+## Aliases
+
+You can use the `pdx` alias instead of `plandex` to type a bit less, and most common commands have their own aliases as well.
+
+Here are the same commands we went through above using aliases to minimize typing:
+
+```bash
+pdx new
+pdx l some-file.ts another-file.ts # load
+pdx t -f prompt.txt # tell
+pdx diff
+pdx ch # changes
+pdx log
+pdx rw e7e06e0 # rewind
+pdx c # continue
+pdx rj components/charts.tsx # reject
+pdx ap # apply
+```
\ No newline at end of file