Skip to content

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

Update documentation for v2 features and migration

Dane Schneider71ade62077b7
diff --git a/docs/docs/cli-reference.md b/docs/docs/cli-reference.md
index 855c3d98..e389af95 100644
--- a/docs/docs/cli-reference.md
+++ b/docs/docs/cli-reference.md
@@ -291,7 +291,7 @@ pdx t # alias
`--no-build/-n`: Don't build proposed changes into pending file updates. Defaults to opposite of config value `auto-build`.
-`--bg`: Run task in the background.
+`--bg`: Run task in the background. Only allowed if `--auto-load-context` and `--apply/-a` are not enabled. Not allowed with the default [autonomy level](./core-concepts/autonomy.md) in Plandex v2.
`--auto-update-context`: Automatically confirm context updates. Defaults to config value `auto-update-context`.
@@ -325,7 +325,7 @@ pdx c # alias
`--no-build/-n`: Don't build proposed changes into pending file updates. Defaults to opposite of config value `auto-build`.
-`--bg`: Run task in the background.
+`--bg`: Run task in the background. Only allowed if `--auto-load-context` and `--apply/-a` are not enabled. Not allowed with the default [autonomy level](./core-concepts/autonomy.md) in Plandex v2.
`--auto-update-context`: Automatically confirm context updates. Defaults to config value `auto-update-context`.
@@ -354,14 +354,12 @@ plandex build
pdx b # alias
```
-`--bg`: Build in the background.
+`--bg`: Build in the background. Not allowed if `--apply/-a` is enabled.
`--stop/-s`: Stop after a single model response (don't auto-continue). Defaults to opposite of config value `auto-continue`.
`--no-build/-n`: Don't build proposed changes into pending file updates. Defaults to opposite of config value `auto-build`.
-`--bg`: Run task in the background.
-
`--auto-update-context`: Automatically confirm context updates. Defaults to config value `auto-update-context`.
`--no-exec`: Don't execute commands after successful apply. Defaults to opposite of config value `can-exec`.
@@ -387,7 +385,7 @@ pdx ch # alias
`--file/-f`: File path containing prompt.
-`--bg`: Run task in the background.
+`--bg`: Run task in the background. Not allowed if `--auto-load-context` is enabled. Not allowed with the default [autonomy level](./core-concepts/autonomy.md) in Plandex v2.
`--auto-update-context`: Automatically confirm context updates. Defaults to config value `auto-update-context`.
@@ -435,8 +433,6 @@ plandex apply
pdx ap # alias
```
-`--bg`: Run task in the background.
-
`--auto-update-context`: Automatically confirm context updates. Defaults to config value `auto-update-context`.
`--no-exec`: Don't execute commands after successful apply. Defaults to opposite of config value `can-exec`.
diff --git a/docs/docs/core-concepts/_category_.json b/docs/docs/core-concepts/_category_.json
index 15ebc79f..5700aec2 100644
--- a/docs/docs/core-concepts/_category_.json
+++ b/docs/docs/core-concepts/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Core Concepts",
- "position": 4,
+ "position": 5,
"collapsible": true,
"collapsed": false
}
\ No newline at end of file
diff --git a/docs/docs/core-concepts/background-tasks.md b/docs/docs/core-concepts/background-tasks.md
index 869a2ede..6f95930d 100644
--- a/docs/docs/core-concepts/background-tasks.md
+++ b/docs/docs/core-concepts/background-tasks.md
@@ -7,6 +7,8 @@ sidebar_label: Background Tasks
Plandex allows you to run tasks in the background, helping you work on multiple tasks in parallel.
+**Note:** in Plandex v2, sending tasks to the background is disabled by default, because it's not compatible with automatic context loading. If you set a lower [autonomy level](./autonomy.md), you can use background tasks.
+
## Running a Task in the Background
To run a task in the background, use the `--bg` flag with `plandex tell` or `plandex continue`.
diff --git a/docs/docs/hosting/_category_.json b/docs/docs/hosting/_category_.json
index e73fbe89..1d51b793 100644
--- a/docs/docs/hosting/_category_.json
+++ b/docs/docs/hosting/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Hosting",
- "position": 6,
+ "position": 7,
"collapsible": true,
"collapsed": false
}
\ No newline at end of file
diff --git a/docs/docs/hosting/self-hosting/local-mode-quickstart.md b/docs/docs/hosting/self-hosting/local-mode-quickstart.md
index 1331e5e9..cc9fa64b 100644
--- a/docs/docs/hosting/self-hosting/local-mode-quickstart.md
+++ b/docs/docs/hosting/self-hosting/local-mode-quickstart.md
@@ -7,6 +7,8 @@ sidebar_label: Local Mode Quickstart
Plandex is open source and uses a client-server architecture. The server can be self-hosted. You can either run it locally or on a cloud server that you control. To run it on a cloud server, go to [Advanced Self-Hosting](./advanced-self-hosting) section. To run it locally, keep reading below.
+**Note for v1 users:** Both the Plandex v2 server and CLI are designed to run *separately* from v1. It's not an in-place upgrade. [More details here.](../../upgrading-v1-to-v2.md)
+
## Local Mode Quickstart
The quickstart requires git, docker, and docker-compose. It's designed for local use with a single user.
diff --git a/docs/docs/models/_category_.json b/docs/docs/models/_category_.json
index a043f526..c29b560c 100644
--- a/docs/docs/models/_category_.json
+++ b/docs/docs/models/_category_.json
@@ -1,6 +1,6 @@
{
"label": "Models",
- "position": 5,
+ "position": 6,
"collapsible": true,
"collapsed": false
}
\ No newline at end of file
diff --git a/docs/docs/quick-start.md b/docs/docs/quick-start.md
index fbe3b31a..f474a78d 100644
--- a/docs/docs/quick-start.md
+++ b/docs/docs/quick-start.md
@@ -8,9 +8,11 @@ sidebar_label: Quickstart
## Install Plandex
```bash
-curl -sL https://v2.plandex.ai/install.sh | bash
+curl -sL https://plandex.ai/install.sh | bash
```
+**Note for v1 users:** when you install the Plandex v2 CLI with the quick install script, it will rename your existing `plandex` command to `plandex1` (and the `pdx` alias to `pdx1`). Plandex v2 is designed to run *separately* from v1 rather than upgrading in place. [More details here.](./upgrading-v1-to-v2.md)
+
[Click here for more installation options.](./install.md)
Note 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.
diff --git a/docs/docs/repl.md b/docs/docs/repl.md
index e57123b3..33a6f589 100644
--- a/docs/docs/repl.md
+++ b/docs/docs/repl.md
@@ -1,5 +1,5 @@
---
-sidebar_position: 3
+sidebar_position: 4
sidebar_label: REPL
---
diff --git a/docs/docs/upgrading-v1-to-v2.md b/docs/docs/upgrading-v1-to-v2.md
new file mode 100644
index 00000000..37abc8e4
--- /dev/null
+++ b/docs/docs/upgrading-v1-to-v2.md
@@ -0,0 +1,25 @@
+---
+sidebar_position: 3
+sidebar_label: From v1 to v2
+---
+
+# Moving from v1 to v2
+
+While built on the same foundations, Plandex v2 is designed to be run separately and independently from v1. It's not an in-place upgrade. So there's nothing in particular you need to do to upgrade; just [install](./install.md) v2 as if you were a brand new user.
+
+## Future Versions
+
+While it would have been nice to maintain compatibility, the large scope of changes and experimental nature of v1 made it more trouble than it was worth.
+
+That said, going forward, the intention is to release future versions as in-place upgrades so that all your projects and data will remain in one place.
+
+## Feedback
+
+If you're a v1 user and you really want to bring your existing plans into v2, please [speak up on Discord](https://discord.gg/plandex-ai) or [on GitHub](https://github.com/plandex-ai/plandex/discussions). This is doable, but I want to be sure there's demand for it before putting in the work.
+
+## What's New?
+
+Check out the [2.0.0 release notes](https://github.com/plandex-ai/plandex/releases/tag/v2.0.0) for an overview of what's new in v2. There's a lot!
+
+
+