Editor integration
Install the current stable planq executable before configuring an editor:
planq version
planq lspThe language server runs over standard input/output. Keep stdout reserved for LSP JSON-RPC. Editor integrations do not download the CLI or reimplement Plan parsing, validation, references, or formatting.
VS Code
Install PlanQ by planq-cli from the Visual Studio Marketplace, or search for planq-cli.planq in VS Code Extensions.
Marketplace version: 0.1.8.
code --install-extension planq-cli.planq@0.1.8For offline installation or recovery, download planq-0.1.8.vsix from the PlanQ 0.1.8 GitHub Release, then install the versioned asset:
GitHub Release VSIX version: 0.1.8. The accepted Release VSIX and Marketplace package currently have the same version and exact bytes.
code --install-extension planq-0.1.8.vsixOpen a .plan file and confirm that the language mode is Plan. Diagnostics, completion, hover, definitions, references, rename, and Format Document come from planq lsp. Format on save is enabled by default for the Plan language. To turn it off at user or workspace scope, use a language-specific setting:
{
"[plan]": {
"editor.formatOnSave": false
}
}VS Code gives language-specific defaults higher precedence than ordinary global or workspace settings, so a non-language-specific "editor.formatOnSave": false does not disable the Plan default.
If VS Code cannot find the executable, first run planq version in the environment used to launch VS Code. Then set the machine-scoped plan.server.path setting to the absolute executable path:
{
"plan.server.path": "/absolute/path/to/planq"
}Do not commit a developer-specific path to workspace settings. The extension always appends the lsp command itself.
Run Plan: Open Preview to Side from a saved local file to open the read-only Gantt workbench bundled with your installed CLI. The extension forces local preview with --local, even when PLAN_SITE is set; it does not require the official site to load the UI. Install the CLI and extension together. The VSIX does not contain a second workbench bundle.
Click a task bar or work-item row to reveal and briefly highlight its source, without moving focus away from the preview. Included items open their defining file; included-plan containers reveal the parent include statement. Navigation is skipped when the target has unsaved changes or no longer matches the preview. Save and wait for the preview to update, then retry. Older CLI workbenches keep working without click-to-source navigation.
Use Plan: Manage in PlanQ in the preview title to open workspace and GitHub management in your external browser. This explicit online action does not upload the local preview. See Local Preview.
Desktop localhost preview is supported. Automatic preview port mapping for Remote SSH, Dev Containers, and Codespaces is not supported.
To reinstall the accepted offline package and check the installed version:
code --install-extension planq-0.1.8.vsix --force
code --list-extensions --show-versions | grep '^planq-cli\.planq@'The VSIX does not contain the planq executable.
Emacs
plan-ts-mode supports Emacs 29.1 or later. Install the mode from the official public repository:
(require 'package)
(package-vc-install "https://github.com/planq-cli/plan-ts-mode")
(require 'plan-ts-mode)Install the Plan tree-sitter grammar from the same versioned repository:
git clone --depth 1 --branch v1.0.0 \
https://github.com/planq-cli/plan-ts-mode.git
cd plan-ts-mode/grammar/tree-sitter-plan
scripts/build-dylib.sh
scripts/install-grammar.shRestart Emacs, open a .plan file, and verify:
(derived-mode-p 'plan-ts-mode) ; => t
(treesit-ready-p 'plan t) ; => tThe mode and grammar provide highlighting, comments, structural indentation, navigation, and imenu without an LSP client. Missing grammar support does not block the major mode; Emacs shows the public installation link and skips tree-sitter setup.
Format on save uses the separately installed planq executable. Set plan-ts-mode-plan-command when it is not on Emacs' exec-path.
The repository also includes an optional lsp-bridge configuration for planq lsp. Installing the mode does not enable lsp-bridge or modify global LSP settings.
Neovim
PlanQ does not publish a Neovim plugin. You may configure a standard LSP client to launch planq lsp for files ending in .plan. Syntax highlighting, installation packaging, and an embedded Gantt preview are not provided as a supported Neovim integration.
Formatting behavior
Formatting is deterministic and validates the result. It can materialize derived IDs and normalize layout, but it does not repair business constraints or silently migrate old reference syntax. Review changes before committing.
For a browser-only view while editing, run planq dev in a terminal. See Local Preview.