|
1 | 1 | # Roo-Cline |
2 | 2 |
|
3 | | -## Roo Packaging and Installation |
| 3 | +### Installation |
| 4 | +If you want to install the latest extension from the Marketplace, just search for "Roo Cline" in your VSCode-compatible editor's Extensions panel (Cmd/Ctrl+Shift+X). |
4 | 5 |
|
5 | | -### Setup |
| 6 | +After installation, Roo Cline will appear in your VSCode-compatible editor's installed extensions list. You can verify this by opening your editor's Extensions panel (Cmd/Ctrl+Shift+X) and checking under the "Installed" section. |
6 | 7 |
|
7 | | -- Install dependencies: |
| 8 | +### Testing Builds |
| 9 | +1. Install dependencies: |
8 | 10 | ```bash |
9 | 11 | npm run install:all |
10 | 12 | ``` |
11 | | -- Now you can either: |
12 | | - 1. Install the latest extension from `bin/roo-cline-<latest_version>.vsix`, skip the packaging steps below |
13 | | - 2. Or build the extension from source and proceed to the packaging steps below |
14 | | - |
15 | 13 |
|
16 | | -### Packaging |
17 | | -1. **If** you have new changes, bump the version in `package.json` |
18 | | - - Remove the old VSIX file: |
19 | | - ```bash |
20 | | - rm bin/roo-cline-*.vsix |
21 | | - ``` |
22 | 14 | 2. Build the VSIX file: |
23 | 15 | ```bash |
24 | 16 | npm run build |
25 | 17 | ``` |
26 | 18 | 3. The new VSIX file will be created in the `bin/` directory |
27 | | -4. Commit the new VSIX file to git: |
28 | | - ```bash |
29 | | - git add bin/*.vsix |
30 | | - git commit -m "chore: update VSIX to version <new_version>" |
31 | | - ``` |
| 19 | +4. Install the extension from the VSIX file as described below: |
32 | 20 |
|
33 | | -### Installation |
34 | | -- **Option 1:** Follow these [instructions](https://www.cursor.com/how-to-install-extension) to manually drag the `.vsix` file into Cursor's Extensions panel (Cmd/Ctrl+Shift+X) and install it. |
| 21 | + - **Option 1:** Drag and drop the `.vsix` file into your VSCode-compatible editor's Extensions panel (Cmd/Ctrl+Shift+X). |
35 | 22 |
|
36 | | -- **Option 2:** Make sure you have the Cursor CLI installed and in your PATH. |
37 | | - `export PATH="$PATH:/Applications/Cursor.app/Contents/MacOS"` |
38 | | -- Install the plugin using the Cursor CLI: |
| 23 | + - **Option 2:** Install the plugin using the CLI, make sure you have your VSCode-compatible CLI installed and in your `PATH` variable. Cursor example: `export PATH="$PATH:/Applications/Cursor.app/Contents/MacOS"` |
39 | 24 |
|
40 | 25 | ```bash |
41 | | - cursor --install-extension bin/roo-cline-<latest_version>.vsix |
42 | 26 | # Ex: cursor --install-extension bin/roo-cline-2.0.1.vsix |
| 27 | + # Ex: code --install-extension bin/roo-cline-2.0.1.vsix |
43 | 28 | ``` |
44 | 29 |
|
45 | | -**Note:** The VSIX file is checked into the git repository's `bin/` directory for easy distribution. |
46 | | - |
47 | | -After installation, Roo Cline will appear in your VSCode-compatible editor's installed extensions list. You can verify this by opening your editor's Extensions panel (Cmd/Ctrl+Shift+X) and checking under the "Installed" section. |
48 | | - |
49 | 30 | ### Publishing |
50 | | - |
51 | 31 | We use [changesets](https://github.com/changesets/changesets) for versioning and publishing this package. To make changes: |
52 | 32 |
|
53 | 33 | 1. Create a PR with your changes |
54 | 34 | 2. Create a new changeset by running `npm run changeset` |
55 | 35 | - Select the appropriate kind of change - `patch` for bug fixes, `minor` for new features, or `major` for breaking changes |
56 | 36 | - Write a clear description of your changes that will be included in the changelog |
57 | | -3. Get the PR approved |
| 37 | +3. Get the PR approved and pass all checks |
58 | 38 | 4. Merge it |
59 | 39 |
|
60 | 40 | Once your merge is successful: |
61 | | -- The release workflow will automatically create a new "Version Packages" PR |
| 41 | +- The release workflow will automatically create a new "Changeset version bump" PR |
62 | 42 | - This PR will: |
63 | 43 | - Update the version based on your changeset |
64 | 44 | - Update the CHANGELOG.md file |
|
0 commit comments