@vanthaita/orca 0.1.26 → 0.1.27
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 +54 -27
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -28,7 +28,11 @@ It's not just a wrapper; it's a workflow engine designed for the era of AI-assis
|
|
|
28
28
|
## ✨ Features
|
|
29
29
|
|
|
30
30
|
- **🧠 Intelligent Commits**: Analyzes your diffs and generates conventional commit messages automatically.
|
|
31
|
-
-
|
|
31
|
+
- **🌊 Workflow Orchestration**: Manage feature branches and lifecycles with `orca flow`.
|
|
32
|
+
- **📚 Stacked Branches**: handle complex dependencies with `orca stack`.
|
|
33
|
+
- **🧹 History Tidying**: Clean up your commit history with interactive rebase and autosquash using `orca tidy`.
|
|
34
|
+
- **🛡️ Safety Checks**: Prevent secret leaks and run preflight checks with `orca safe`.
|
|
35
|
+
- **🗺️ Strategic Planning**: Generates a `plan.json` for complex tasks.
|
|
32
36
|
- **🚀 Zero-Friction Releases**: Handles the entire publish flow—commits, pushes, and creates a PR with a generated summary in one command.
|
|
33
37
|
- **🔒 Local-First Privacy**: Your code stays on your machine. Orca interacts with AI providers securely using your own API keys.
|
|
34
38
|
- **⚡ Blazing Fast**: Built with Rust for instant startup times and high performance.
|
|
@@ -76,16 +80,6 @@ curl -fsSL https://raw.githubusercontent.com/vanthaita/orca-releases/main/instal
|
|
|
76
80
|
2. Run the installer.
|
|
77
81
|
3. Open a new terminal and type `orca --help`.
|
|
78
82
|
|
|
79
|
-
### Portable Archive
|
|
80
|
-
|
|
81
|
-
Download the appropriate archive for your platform from [Releases](https://github.com/vanthaita/orca-releases/releases/latest):
|
|
82
|
-
|
|
83
|
-
- **Windows**: `orca-x86_64-pc-windows-msvc.zip`
|
|
84
|
-
- **macOS**: `orca-x86_64-apple-darwin.tar.gz`
|
|
85
|
-
- **Linux**: `orca-x86_64-unknown-linux-gnu.tar.gz`
|
|
86
|
-
|
|
87
|
-
Extract and add to your system PATH.
|
|
88
|
-
|
|
89
83
|
### From Source
|
|
90
84
|
|
|
91
85
|
Requirements: [Rust](https://rustup.rs/) (stable)
|
|
@@ -102,9 +96,13 @@ cargo install --path .
|
|
|
102
96
|
## 🛠️ Usage
|
|
103
97
|
|
|
104
98
|
### 1. Setup
|
|
105
|
-
Configure your preferred AI provider and API keys.
|
|
99
|
+
Configure your preferred AI provider (Gemini, OpenAI, etc.) and API keys.
|
|
106
100
|
|
|
107
101
|
```bash
|
|
102
|
+
# Setup with Gemini (default)
|
|
103
|
+
orca setup --provider gemini --api-key YOUR_API_KEY
|
|
104
|
+
|
|
105
|
+
# Setup with OpenAI
|
|
108
106
|
orca setup --provider openai --api-key sk-...
|
|
109
107
|
```
|
|
110
108
|
|
|
@@ -116,20 +114,42 @@ Stage changes and generate a commit message in one go.
|
|
|
116
114
|
orca commit
|
|
117
115
|
```
|
|
118
116
|
|
|
119
|
-
### 3.
|
|
117
|
+
### 3. Workflow Management
|
|
118
|
+
Start and finish features with ease.
|
|
119
|
+
|
|
120
|
+
```bash
|
|
121
|
+
# Start a new feature
|
|
122
|
+
orca flow start --type feat --name user-auth
|
|
123
|
+
|
|
124
|
+
# ... do work ...
|
|
125
|
+
|
|
126
|
+
# Finish the feature (push and create PR)
|
|
127
|
+
orca flow finish --push --pr
|
|
128
|
+
```
|
|
129
|
+
|
|
130
|
+
### 4. Stacked Branches
|
|
131
|
+
Manage dependent branches without the headache.
|
|
132
|
+
|
|
133
|
+
```bash
|
|
134
|
+
# Create a child branch
|
|
135
|
+
orca stack start my-child-branch
|
|
136
|
+
|
|
137
|
+
# Rebase the stack if the parent moves
|
|
138
|
+
orca stack rebase
|
|
139
|
+
```
|
|
140
|
+
|
|
141
|
+
### 5. Advanced Planning
|
|
120
142
|
For complex features, generate a plan first.
|
|
121
143
|
|
|
122
144
|
```bash
|
|
123
|
-
# Generate a plan
|
|
145
|
+
# Generate a plan
|
|
124
146
|
orca plan --out plan.json
|
|
125
147
|
|
|
126
|
-
# ... Edit plan.json manually if needed ...
|
|
127
|
-
|
|
128
148
|
# Execute the plan
|
|
129
149
|
orca apply --file plan.json
|
|
130
150
|
```
|
|
131
151
|
|
|
132
|
-
###
|
|
152
|
+
### 6. Publishing
|
|
133
153
|
Ship your changes to GitHub without leaving the terminal.
|
|
134
154
|
|
|
135
155
|
```bash
|
|
@@ -139,16 +159,23 @@ orca publish --branch feat/my-new-feature
|
|
|
139
159
|
|
|
140
160
|
## ⌨️ Commands
|
|
141
161
|
|
|
142
|
-
| Command | Description |
|
|
143
|
-
|
|
144
|
-
| `orca commit` | Analyze changes and create a commit. |
|
|
145
|
-
| `orca
|
|
146
|
-
| `orca
|
|
147
|
-
| `orca
|
|
148
|
-
| `orca
|
|
149
|
-
| `orca
|
|
150
|
-
| `orca
|
|
151
|
-
| `orca
|
|
162
|
+
| Command | Alias | Description |
|
|
163
|
+
|---------|-------|-------------|
|
|
164
|
+
| `orca commit` | | Analyze changes and create a commit. |
|
|
165
|
+
| `orca flow` | `fl` | Manage feature/fix workflows (`start`, `finish`). |
|
|
166
|
+
| `orca stack` | `sk` | Manage stacked branches (`start`, `list`, `rebase`, `publish`). |
|
|
167
|
+
| `orca tidy` | `td` | Clean up history (`rebase`, `squash`, `fixup`, `amend`). |
|
|
168
|
+
| `orca conflict` | `cf` | Resolve conflicts (`status`, `guide`, `continue`, `abort`). |
|
|
169
|
+
| `orca release` | `rl` | Manage releases (`tag`, `notes`, `create`). |
|
|
170
|
+
| `orca safe` | | Safety checks (`scan`, `preflight`). |
|
|
171
|
+
| `orca git` | `g` | Enhanced git wrappers (`status`, `log`, `sync`). |
|
|
172
|
+
| `orca branch` | `br` | Branch management (`current`, `list`, `new`, `publish`). |
|
|
173
|
+
| `orca plan` | | Generate a detailed execution plan. |
|
|
174
|
+
| `orca apply` | | Execute a plan file. |
|
|
175
|
+
| `orca publish` | | Commit, push, and create a PR. |
|
|
176
|
+
| `orca setup` | | Configure AI providers and settings. |
|
|
177
|
+
| `orca update` | | Update to the latest version. |
|
|
178
|
+
| `orca doctor` | | Check environment health. |
|
|
152
179
|
|
|
153
180
|
## 🤝 Contributing
|
|
154
181
|
|