VS Code extension
The Phillip extension for VS Code puts Tara resources, your Bandum tasks, and the issue you're working on in the Activity Bar. This page shows how to install it, what its parts are, and what to do when it can't find ph.
The extension doesn't call its own API and doesn't hold tokens. It runs ph commands for you, with --json to get data or by opening the integrated terminal for long commands, so sign-in, tokens, and permissions all belong to ph. That's why you need to install and sign in to Phillip first (see Detailed installation), then open the project's repo folder, which has an origin and, if the project uses Tara, a phillip.lock. If the extension reports "the … output from ph is not JSON", your Phillip is out of date, so update it.
Install the extension
The extension is a .vsix file that Tara serves next to the Phillip package (https://tara.phillipcli.cloud/phillip/phillip-vscode-<version>.vsix, and phillip-vscode-latest.vsix for the newest one; https://tara.phillipcli.cloud/phillip/latest.json lists the current version under vscode). Download and install it from the command line:
curl -fsSLo phillip-vscode.vsix https://tara.phillipcli.cloud/phillip/phillip-vscode-latest.vsix
code --install-extension phillip-vscode.vsixIf your Tara requires sign-in for downloads, sign in on the Tara page first and open the same address in the browser to save the file.
Or in VS Code, open Extensions, click the ... menu, and choose Install from VSIX.... If Phillip isn't installed or you're not signed in, the extension says so clearly and has a button that opens a terminal to run ph setup.
What's in the extension?
| Part | Content | Underlying ph command |
|---|---|---|
| Tara panel | Installed resources (from phillip.lock), new versions, and warnings about yanked versions. Search, add, install, and upgrade resources | ph tara list, outdated, search; add, install, upgrade |
| Bandum: my tasks panel | Tasks assigned to you by state, with tasks that need fixing first. Buttons on each row: start, automated test, manual test, open PR | ph bandum board --mine; start, verify, test, pr |
| Status bar | Shown as GH-12 · in progress. The issue is inferred from the feature/GH-<n>-... branch, and the state comes from the board. Click to open the issue | git and the loaded board |
ph tara listNAME VERSION STATUS SOURCEagent-ba 1.1.1 dependency of harness-rnd-sdlcagent-dev 1.1.1 dependency of harness-rnd-sdlcagent-devops 1.1.1 dependency of harness-rnd-sdlcagent-docs 1.1.1 dependency of harness-rnd-sdlcagent-plan 1.1.1 dependency of harness-rnd-sdlcagent-po 1.1.1 dependency of harness-rnd-sdlcagent-reviewer 1.1.1 dependency of harness-rnd-sdlcagent-sa 1.1.1 dependency of harness-rnd-sdlcagent-security 1.1.1 dependency of harness-rnd-sdlcagent-test 1.3.2 dependency of harness-rnd-sdlcagent-uiux 1.1.1 dependency of harness-rnd-sdlcharness-rnd-sdlc 1.5.3 required by the projectkit-ryoma-session 1.0.2 dependency of harness-rnd-sdlckit-scm-github 1.3.0 dependency of harness-rnd-sdlckit-sdlc-guard 1.1.1 dependency of harness-rnd-sdlcprompt-release-note 1.0.2 dependency of harness-rnd-sdlcskill-sdlc 1.5.1 dependency of harness-rnd-sdlcRequirements: harness-rnd-sdlc@^1.5.0If a task already has an open PR, its row has a button to open the PR, and the right-click menu has one too. To create a PR from the current branch, use the Phillip: Create PR/MR from the current branch (ph bandum pr) command, which maps to ph bandum pr. If the project doesn't use Tara yet, meaning it has no phillip.lock, the Tara panel shows two entries: Initialize with a harness (ph init …) and Find and add resources.
When the workspace has several folders, the extension picks the project folder by the open file first, then by the folder that has phillip.lock. When you switch to a file in another folder, the panel and status bar refresh on their own. Every command is in the Command Palette with the Phillip: prefix, for example Phillip: Refresh and Phillip: Set up (ph setup)).
Settings
| Setting | Default | Meaning |
|---|---|---|
phillip.path | ph | The path to the ph command. If you leave the default, the extension finds it on its own |
phillip.bandumUrl | http://localhost:8070 | The address of the Bandum web app, with the same meaning as PHILLIP_BANDUM_URL. If you use your organization's online Bandum, set that address |
Phillip is installed but the extension says it isn't
VS Code opened from the Dock or the Start menu often has a minimal PATH that doesn't include npm's global bin directory. Meanwhile, ph needs node to be in the PATH. The extension looks for ph in this order: the phillip.path value if you set one, VS Code's PATH, your login shell's PATH, then common directories such as ~/.npm-global/bin, /opt/homebrew/bin, the bin directory of the npm prefix, and %APPDATA%\npm on Windows.
If it still fails, follow these steps.
- Find the real path of
phin a terminal withwhich ph(where phon Windows). - Set
phillip.pathto that full path. Or quit VS Code completely and reopen it from a terminal withcode .so it inherits yourPATH. - Open View, Output, and choose the Phillip channel to see which
phpath it uses, which commands it ran, and the errors. - After you change a setting, run Phillip: Refresh.
node must still be findable, usually in /usr/local/bin or your Node version manager's directory. How to add npm's directory to PATH is in Detailed installation and Troubleshooting.
The extension doesn't have a Ryoma panel yet. To see metrics, use ph ryoma or the web.