Manage Arashi worktrees directly from VS Code.
- Run core Arashi commands from the command palette:
init,add,clone,create,pull,sync,switch,remove - Open the workspace root or a related repository in a new VS Code window from command-palette or panel flows
- Browse worktrees in the Arashi Worktrees panel grouped by repository with repo, branch, path, and change status
- Trigger contextual panel actions for switching, removing, refreshing, creating, and opening related repositories
- Capture command context and diagnostics in the Arashi output channel
- Use
arashi clonefrom the integrated terminal to recover missing configured repositories
The extension UI lives in the Explorer sidebar as Arashi Worktrees.
- Open the Explorer view in VS Code.
- Look for the Arashi Worktrees section below your normal file tree.
- If it is collapsed, expand it.
- If it is hidden, open the Explorer view menu and re-enable Arashi Worktrees.
The panel appears after the extension activates for the current workspace. If you work from a child repo, set arashi.workspaceRoot when you want commands to execute against a different Arashi root.
Use this quick walkthrough when the panel is visible:
- Use the title-bar
+action to runArashi: Create Worktree. - Use the title-bar refresh action after external terminal changes, or simply refocus the editor to let the panel refresh itself.
- Expand a repository node to inspect the worktrees associated with that repo.
- Select the inline arrow action on a worktree to switch to that exact worktree.
- Select the inline trash action on a worktree to remove it with a single confirmation.
- Use the repository context action or
Arashi: Open Related Repositoryto open a repo-focused VS Code window.
This README uses structured guidance instead of screenshots so the onboarding text stays accurate across Marketplace and editor variants.
- VS Code with extension API support for
^1.96.2 arashiCLI available on your systemPATH(or configured witharashi.binaryPath)- Install or upgrade the CLI using the docs site: https://arashi.haphazard.dev/getting-started/
arashi.binaryPath: Path to the Arashi binary (default:arashi)arashi.workspaceRoot: Root path where commands execute (default: active workspace folder)arashi.commandTimeoutMs: Per-command timeout in milliseconds (default:120000)
For Arashi CLI installation steps, use the canonical docs guide at https://arashi.haphazard.dev/getting-started/. This README keeps extension-specific install and upgrade information only.
- Open Extensions in VS Code
- Search for
Arashi - Install and use extension updates from the built-in update flow
- Open Extensions in VS Code
- Search Open VSX for
Arashi - Install and update from your editor's extension manager
Both marketplace releases are built from the same tagged artifact so version numbers remain aligned.
- Officially targets
engines.vscode: ^1.96.2 - Uses stable VS Code APIs to preserve compatibility with VS Code forks
- If your editor supports standard VS Code extensions at that engine range, behavior should match documented command and panel flows
Open repos/arashi-vscode as the active workspace folder before launching debug configs.
- Install dependencies:
bun install - Start extension debug host: press
F5withRun Extension(build once, most reliable) - For a hot-reload loop, use
Run Extension (Watch)which runswatch:tscandwatch:buildin parallel
The launch configurations mirror the oil.code workflow structure (extension-host launch plus watch mode), and sourcemaps are enabled for source-level debugging.
- Pull requests run lint, tests, and build via
.github/workflows/ci.yml. - Releases run via manual GitHub Actions dispatch (
Releaseworkflow). - The release workflow uses
semantic-releaseto:- generate release notes and update
CHANGELOG.md - bump
package.jsonversion and commit both files back to the repository - build/package the extension and publish the same release artifact to VS Marketplace and Open VSX
- generate release notes and update