@vanthaita/orca 0.1.27 → 0.1.28
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +58 -2
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -43,14 +43,19 @@ Choose your preferred installation method:
|
|
|
43
43
|
|
|
44
44
|
### npm (Cross-platform)
|
|
45
45
|
|
|
46
|
+
**Recommended for global installation:**
|
|
47
|
+
|
|
46
48
|
```bash
|
|
47
|
-
npm install -g orca
|
|
49
|
+
npm install -g @vanthaita/orca
|
|
48
50
|
```
|
|
49
51
|
|
|
52
|
+
> [!NOTE]
|
|
53
|
+
> Installing globally (`-g` flag) makes the `orca` command available system-wide. If you've previously installed via MSI or other methods, see the [Installation Notes](#-installation-notes) section below.
|
|
54
|
+
|
|
50
55
|
### Bun (Cross-platform)
|
|
51
56
|
|
|
52
57
|
```bash
|
|
53
|
-
bun install -g orca
|
|
58
|
+
bun install -g @vanthaita/orca
|
|
54
59
|
```
|
|
55
60
|
|
|
56
61
|
### Homebrew (macOS/Linux)
|
|
@@ -93,6 +98,57 @@ cd Orca/cli
|
|
|
93
98
|
cargo install --path .
|
|
94
99
|
```
|
|
95
100
|
|
|
101
|
+
## 📝 Installation Notes
|
|
102
|
+
|
|
103
|
+
### Choosing the Right Installation Method
|
|
104
|
+
|
|
105
|
+
- **Windows users**: Use the [MSI Installer](#windows-msi-installer) for the best experience. It handles PATH configuration automatically.
|
|
106
|
+
- **npm/bun users**: Use the `-g` (global) flag to install system-wide. This makes `orca` available in any directory.
|
|
107
|
+
- **Homebrew/winget users**: These package managers handle global installation automatically.
|
|
108
|
+
|
|
109
|
+
### NPM Installation Tips
|
|
110
|
+
|
|
111
|
+
> [!IMPORTANT]
|
|
112
|
+
> **If you've installed via MSI or another method**, installing via npm may cause conflicts. Choose one installation method and stick with it.
|
|
113
|
+
|
|
114
|
+
**Prevent automatic updates:**
|
|
115
|
+
|
|
116
|
+
By default, npm may update packages automatically depending on your configuration. To lock to a specific version:
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
# Install a specific version
|
|
120
|
+
npm install -g @vanthaita/orca@0.1.27
|
|
121
|
+
|
|
122
|
+
# Check your installed version
|
|
123
|
+
orca --version
|
|
124
|
+
```
|
|
125
|
+
|
|
126
|
+
**Troubleshooting npm installation:**
|
|
127
|
+
|
|
128
|
+
```bash
|
|
129
|
+
# If the command is not found after installation:
|
|
130
|
+
which orca # macOS/Linux
|
|
131
|
+
where orca # Windows
|
|
132
|
+
|
|
133
|
+
# Reinstall if needed:
|
|
134
|
+
npm uninstall -g @vanthaita/orca
|
|
135
|
+
npm install -g @vanthaita/orca
|
|
136
|
+
```
|
|
137
|
+
|
|
138
|
+
### MSI and NPM Conflicts
|
|
139
|
+
|
|
140
|
+
> [!WARNING]
|
|
141
|
+
> If you installed Orca using the **Windows MSI installer**, do not install it again via npm. The MSI installer places the binary in your system PATH, and npm cannot update or manage it.
|
|
142
|
+
|
|
143
|
+
**If you need to switch from MSI to npm:**
|
|
144
|
+
|
|
145
|
+
1. Uninstall Orca via Windows Settings → Apps → Orca
|
|
146
|
+
2. Then install via npm: `npm install -g @vanthaita/orca`
|
|
147
|
+
|
|
148
|
+
**To update an MSI installation:**
|
|
149
|
+
|
|
150
|
+
Download and run the latest MSI installer from [Releases](https://github.com/vanthaita/orca-releases/releases/latest).
|
|
151
|
+
|
|
96
152
|
## 🛠️ Usage
|
|
97
153
|
|
|
98
154
|
### 1. Setup
|
package/package.json
CHANGED
|
@@ -1,7 +1,8 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@vanthaita/orca",
|
|
3
|
-
"version": "0.1.
|
|
4
|
-
"description": "AI-powered Git
|
|
3
|
+
"version": "0.1.28",
|
|
4
|
+
"description": "AI-powered Git workflow CLI for modern developers. Intelligent commits, workflow orchestration, and zero-friction releases.",
|
|
5
|
+
"preferGlobal": true,
|
|
5
6
|
"scripts": {
|
|
6
7
|
"postinstall": "node install.js"
|
|
7
8
|
},
|