@rivocode-cli/cli 1.0.2 → 2.0.1
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/LICENSE +21 -202
- package/README.md +199 -117
- package/bin/rivo.js +30 -8
- package/package.json +5 -7
package/LICENSE
CHANGED
|
@@ -1,202 +1,21 @@
|
|
|
1
|
-
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
|
|
5
|
-
|
|
6
|
-
|
|
7
|
-
|
|
8
|
-
|
|
9
|
-
|
|
10
|
-
|
|
11
|
-
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
-
|
|
24
|
-
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
-
exercising permissions granted by this License.
|
|
26
|
-
|
|
27
|
-
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
-
including but not limited to software source code, documentation
|
|
29
|
-
source, and configuration files.
|
|
30
|
-
|
|
31
|
-
"Object" form shall mean any form resulting from mechanical
|
|
32
|
-
transformation or translation of a Source form, including but
|
|
33
|
-
not limited to compiled object code, generated documentation,
|
|
34
|
-
and conversions to other media types.
|
|
35
|
-
|
|
36
|
-
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
-
Object form, made available under the License, as indicated by a
|
|
38
|
-
copyright notice that is included in or attached to the work
|
|
39
|
-
(an example is provided in the Appendix below).
|
|
40
|
-
|
|
41
|
-
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
-
form, that is based on (or derived from) the Work and for which the
|
|
43
|
-
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
-
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
-
of this License, Derivative Works shall not include works that remain
|
|
46
|
-
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
-
the Work and Derivative Works thereof.
|
|
48
|
-
|
|
49
|
-
"Contribution" shall mean any work of authorship, including
|
|
50
|
-
the original version of the Work and any modifications or additions
|
|
51
|
-
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
-
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
-
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
-
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
-
means any form of electronic, verbal, or written communication sent
|
|
56
|
-
to the Licensor or its representatives, including but not limited to
|
|
57
|
-
communication on electronic mailing lists, source code control systems,
|
|
58
|
-
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
-
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
-
excluding communication that is conspicuously marked or otherwise
|
|
61
|
-
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
-
|
|
63
|
-
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
-
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
-
subsequently incorporated within the Work.
|
|
66
|
-
|
|
67
|
-
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
-
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
-
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
-
Work and such Derivative Works in Source or Object form.
|
|
73
|
-
|
|
74
|
-
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
-
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
-
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
-
(except as stated in this section) patent license to make, have made,
|
|
78
|
-
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
-
where such license applies only to those patent claims licensable
|
|
80
|
-
by such Contributor that are necessarily infringed by their
|
|
81
|
-
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
-
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
-
institute patent litigation against any entity (including a
|
|
84
|
-
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
-
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
-
or contributory patent infringement, then any patent licenses
|
|
87
|
-
granted to You under this License for that Work shall terminate
|
|
88
|
-
as of the date such litigation is filed.
|
|
89
|
-
|
|
90
|
-
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
-
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
-
modifications, and in Source or Object form, provided that You
|
|
93
|
-
meet the following conditions:
|
|
94
|
-
|
|
95
|
-
(a) You must give any other recipients of the Work or
|
|
96
|
-
Derivative Works a copy of this License; and
|
|
97
|
-
|
|
98
|
-
(b) You must cause any modified files to carry prominent notices
|
|
99
|
-
stating that You changed the files; and
|
|
100
|
-
|
|
101
|
-
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
-
that You distribute, all copyright, patent, trademark, and
|
|
103
|
-
attribution notices from the Source form of the Work,
|
|
104
|
-
excluding those notices that do not pertain to any part of
|
|
105
|
-
the Derivative Works; and
|
|
106
|
-
|
|
107
|
-
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
-
distribution, then any Derivative Works that You distribute must
|
|
109
|
-
include a readable copy of the attribution notices contained
|
|
110
|
-
within such NOTICE file, excluding those notices that do not
|
|
111
|
-
pertain to any part of the Derivative Works, in at least one
|
|
112
|
-
of the following places: within a NOTICE text file distributed
|
|
113
|
-
as part of the Derivative Works; within the Source form or
|
|
114
|
-
documentation, if provided along with the Derivative Works; or,
|
|
115
|
-
within a display generated by the Derivative Works, if and
|
|
116
|
-
wherever such third-party notices normally appear. The contents
|
|
117
|
-
of the NOTICE file are for informational purposes only and
|
|
118
|
-
do not modify the License. You may add Your own attribution
|
|
119
|
-
notices within Derivative Works that You distribute, alongside
|
|
120
|
-
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
-
that such additional attribution notices cannot be construed
|
|
122
|
-
as modifying the License.
|
|
123
|
-
|
|
124
|
-
You may add Your own copyright statement to Your modifications and
|
|
125
|
-
may provide additional or different license terms and conditions
|
|
126
|
-
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
-
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
-
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
-
the conditions stated in this License.
|
|
130
|
-
|
|
131
|
-
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
-
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
-
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
-
this License, without any additional terms or conditions.
|
|
135
|
-
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
-
the terms of any separate license agreement you may have executed
|
|
137
|
-
with Licensor regarding such Contributions.
|
|
138
|
-
|
|
139
|
-
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
-
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
-
except as required for reasonable and customary use in describing the
|
|
142
|
-
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
-
|
|
144
|
-
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
-
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
-
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
-
implied, including, without limitation, any warranties or conditions
|
|
149
|
-
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
-
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
-
appropriateness of using or redistributing the Work and assume any
|
|
152
|
-
risks associated with Your exercise of permissions under this License.
|
|
153
|
-
|
|
154
|
-
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
-
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
-
unless required by applicable law (such as deliberate and grossly
|
|
157
|
-
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
-
liable to You for damages, including any direct, indirect, special,
|
|
159
|
-
incidental, or consequential damages of any character arising as a
|
|
160
|
-
result of this License or out of the use or inability to use the
|
|
161
|
-
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
-
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
-
other commercial damages or losses), even if such Contributor
|
|
164
|
-
has been advised of the possibility of such damages.
|
|
165
|
-
|
|
166
|
-
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
-
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
-
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
-
or other liability obligations and/or rights consistent with this
|
|
170
|
-
License. However, in accepting such obligations, You may act only
|
|
171
|
-
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
-
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
-
defend, and hold each Contributor harmless for any liability
|
|
174
|
-
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
-
of your accepting any such warranty or additional liability.
|
|
176
|
-
|
|
177
|
-
END OF TERMS AND CONDITIONS
|
|
178
|
-
|
|
179
|
-
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
-
|
|
181
|
-
To apply the Apache License to your work, attach the following
|
|
182
|
-
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
-
replaced with your own identifying information. (Don't include
|
|
184
|
-
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
-
comment syntax for the file format. We also recommend that a
|
|
186
|
-
file or class name and description of purpose be included on the
|
|
187
|
-
same "printed page" as the copyright notice for easier
|
|
188
|
-
identification within third-party archives.
|
|
189
|
-
|
|
190
|
-
Copyright 2025-2026 RivoCode (Created by Sanket Padhyal)
|
|
191
|
-
|
|
192
|
-
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
-
you may not use this file except in compliance with the License.
|
|
194
|
-
You may obtain a copy of the License at
|
|
195
|
-
|
|
196
|
-
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
-
|
|
198
|
-
Unless required by applicable law or agreed to in writing, software
|
|
199
|
-
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
-
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
-
See the License for the specific language governing permissions and
|
|
202
|
-
limitations under the License.
|
|
1
|
+
MIT License
|
|
2
|
+
|
|
3
|
+
Copyright (c) 2026 Sanket Padhyal
|
|
4
|
+
|
|
5
|
+
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
6
|
+
of this software and associated documentation files (the "Software"), to deal
|
|
7
|
+
in the Software without restriction, including without limitation the rights
|
|
8
|
+
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
9
|
+
copies of the Software, and to permit persons to whom the Software is
|
|
10
|
+
furnished to do so, subject to the following conditions:
|
|
11
|
+
|
|
12
|
+
The above copyright notice and this permission notice shall be included in all
|
|
13
|
+
copies or substantial portions of the Software.
|
|
14
|
+
|
|
15
|
+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
16
|
+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
17
|
+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
18
|
+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
19
|
+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
20
|
+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
21
|
+
SOFTWARE.
|
package/README.md
CHANGED
|
@@ -1,177 +1,259 @@
|
|
|
1
|
-
|
|
1
|
+
<div align="center">
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
<img src="logo0.png" alt="RivoCode Logo" width="120" height="120" />
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
# RivoCode CLI
|
|
6
6
|
|
|
7
|
-
|
|
8
|
-
- Interactive chat with AI assistants directly in your terminal
|
|
9
|
-
- Syntax-highlighted code blocks with copy support
|
|
10
|
-
- Markdown rendering for rich responses
|
|
11
|
-
- Message threading for conversation context
|
|
7
|
+
**A modern, terminal-native AI coding assistant built for speed, full codebase awareness, and multi-file workflows.**
|
|
12
8
|
|
|
13
|
-
|
|
14
|
-
-
|
|
15
|
-
-
|
|
16
|
-
-
|
|
17
|
-
- Support for multiple file formats
|
|
9
|
+
[](https://www.npmjs.com/package/@rivocode-cli/cli)
|
|
10
|
+
[](LICENSE)
|
|
11
|
+
[](https://github.com/sanketpadhyal/RivoCode-Cli/releases)
|
|
12
|
+
[](https://nodejs.org)
|
|
18
13
|
|
|
19
|
-
|
|
20
|
-
- Multiple AI provider support:
|
|
21
|
-
- **MiniMax** (MiniMax-M3) - Fast, cost-effective LLM
|
|
22
|
-
- **Llama 3.3** - Open source model
|
|
23
|
-
- **Gemini** - Google's AI model
|
|
24
|
-
- Easy model switching via model picker
|
|
25
|
-
- Streaming responses for real-time output
|
|
14
|
+
</div>
|
|
26
15
|
|
|
27
|
-
|
|
28
|
-
- Codebase-aware AI assistance
|
|
29
|
-
- AST-based indexing for intelligent context
|
|
30
|
-
- Automatic project structure analysis
|
|
31
|
-
- Vector embeddings for semantic search
|
|
16
|
+
---
|
|
32
17
|
|
|
33
|
-
|
|
34
|
-
- Read, write, and edit files directly from chat
|
|
35
|
-
- Run terminal commands
|
|
36
|
-
- Search and replace across files
|
|
37
|
-
- Create and manage project structure
|
|
18
|
+
## Overview
|
|
38
19
|
|
|
39
|
-
|
|
20
|
+
RivoCode is an autonomous AI coding assistant that operates directly within your terminal. It indexes your project AST with Tree-Sitter, plans architectural implementations, edits multiple files across your workspace, executes shell commands, and connects to high-performance LLM providers without requiring desktop IDE context switching.
|
|
40
21
|
|
|
41
|
-
|
|
42
|
-
- **TypeScript** for type safety
|
|
43
|
-
- **Expo Router** for file-based navigation
|
|
44
|
-
- **Zustand** for state management
|
|
45
|
-
- **TanStack Query** for data fetching
|
|
46
|
-
- **OpenAI SDK** for AI integrations
|
|
22
|
+
---
|
|
47
23
|
|
|
48
|
-
##
|
|
24
|
+
## Quick Start
|
|
49
25
|
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
1. Sign up at [MiniMax Platform](https://platform.minimax.io)
|
|
53
|
-
2. Get your API key from the dashboard
|
|
54
|
-
3. Configure in your environment:
|
|
26
|
+
Run RivoCode instantly without manual binary downloads:
|
|
55
27
|
|
|
56
28
|
```bash
|
|
57
|
-
|
|
58
|
-
MINIMAX_API_KEY=your_api_key_here
|
|
29
|
+
npx @rivocode-cli/cli
|
|
59
30
|
```
|
|
60
31
|
|
|
61
|
-
|
|
32
|
+
Pass an initial prompt directly from your terminal:
|
|
62
33
|
|
|
63
34
|
```bash
|
|
64
|
-
|
|
65
|
-
curl https://api.minimax.io/v1/chat/completions \
|
|
66
|
-
-H "Authorization: Bearer $MINIMAX_API_KEY" \
|
|
67
|
-
-H "Content-Type: application/json" \
|
|
68
|
-
-d '{
|
|
69
|
-
"model": "MiniMax-M3",
|
|
70
|
-
"messages": [{"role": "user", "content": "Hello!"}]
|
|
71
|
-
}'
|
|
35
|
+
npx @rivocode-cli/cli "Refactor authentication middleware to use JWT"
|
|
72
36
|
```
|
|
73
37
|
|
|
74
|
-
|
|
38
|
+
---
|
|
39
|
+
|
|
40
|
+
## Installation
|
|
75
41
|
|
|
76
|
-
|
|
77
|
-
|---------|-------------|
|
|
78
|
-
| **MiniMax-M3** | Latest LLM model |
|
|
79
|
-
| **Image Generation** | AI image creation |
|
|
80
|
-
| **Video Generation V2** | Text-to-video |
|
|
81
|
-
| **Text-to-Speech** | Voice synthesis |
|
|
82
|
-
| **Voice Design** | Custom voice creation |
|
|
83
|
-
| **Music Generation** | AI music creation |
|
|
42
|
+
Install RivoCode globally across your operating system for access via the `rivo` command.
|
|
84
43
|
|
|
85
|
-
###
|
|
44
|
+
### macOS Installation
|
|
45
|
+
|
|
46
|
+
#### Using npm:
|
|
47
|
+
```bash
|
|
48
|
+
npm install -g @rivocode-cli/cli
|
|
49
|
+
```
|
|
86
50
|
|
|
51
|
+
#### Using Homebrew / Bun:
|
|
87
52
|
```bash
|
|
88
|
-
|
|
53
|
+
bun add -g @rivocode-cli/cli
|
|
89
54
|
```
|
|
90
55
|
|
|
91
|
-
|
|
92
|
-
|
|
56
|
+
#### Using pnpm:
|
|
57
|
+
```bash
|
|
58
|
+
pnpm add -g @rivocode-cli/cli
|
|
59
|
+
```
|
|
93
60
|
|
|
94
|
-
|
|
95
|
-
|
|
61
|
+
#### Using yarn:
|
|
62
|
+
```bash
|
|
63
|
+
yarn global add @rivocode-cli/cli
|
|
96
64
|
```
|
|
97
65
|
|
|
98
|
-
|
|
66
|
+
---
|
|
99
67
|
|
|
68
|
+
### Windows Installation
|
|
69
|
+
|
|
70
|
+
Open **PowerShell** or **Command Prompt** (Run as Administrator if necessary):
|
|
71
|
+
|
|
72
|
+
#### Using npm:
|
|
73
|
+
```powershell
|
|
74
|
+
npm install -g @rivocode-cli/cli
|
|
100
75
|
```
|
|
101
|
-
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
│ ├── hooks/ # Custom React hooks
|
|
106
|
-
│ ├── services/ # API and AI service integrations
|
|
107
|
-
│ ├── stores/ # Zustand state stores
|
|
108
|
-
│ ├── types/ # TypeScript type definitions
|
|
109
|
-
│ └── utils/ # Utility functions
|
|
110
|
-
├── assets/ # Static assets
|
|
111
|
-
└── app.json # Expo configuration
|
|
76
|
+
|
|
77
|
+
#### Using pnpm:
|
|
78
|
+
```powershell
|
|
79
|
+
pnpm add -g @rivocode-cli/cli
|
|
112
80
|
```
|
|
113
81
|
|
|
114
|
-
|
|
82
|
+
#### Using yarn:
|
|
83
|
+
```powershell
|
|
84
|
+
yarn global add @rivocode-cli/cli
|
|
85
|
+
```
|
|
115
86
|
|
|
116
|
-
|
|
87
|
+
---
|
|
117
88
|
|
|
118
|
-
|
|
119
|
-
- npm or yarn
|
|
120
|
-
- Expo CLI
|
|
121
|
-
- MiniMax API key (for MiniMax integration)
|
|
89
|
+
### Linux Installation
|
|
122
90
|
|
|
123
|
-
|
|
91
|
+
#### Using npm:
|
|
92
|
+
```bash
|
|
93
|
+
sudo npm install -g @rivocode-cli/cli
|
|
94
|
+
```
|
|
124
95
|
|
|
96
|
+
#### Using bun:
|
|
125
97
|
```bash
|
|
126
|
-
|
|
127
|
-
|
|
128
|
-
cd rivocode
|
|
98
|
+
bun add -g @rivocode-cli/cli
|
|
99
|
+
```
|
|
129
100
|
|
|
130
|
-
|
|
131
|
-
npm install
|
|
101
|
+
---
|
|
132
102
|
|
|
133
|
-
|
|
134
|
-
|
|
103
|
+
### Verify Installation
|
|
104
|
+
|
|
105
|
+
After global installation, launch the CLI from any directory:
|
|
106
|
+
|
|
107
|
+
```bash
|
|
108
|
+
rivo
|
|
109
|
+
```
|
|
110
|
+
|
|
111
|
+
Check the installed version:
|
|
112
|
+
|
|
113
|
+
```bash
|
|
114
|
+
rivo --version
|
|
135
115
|
```
|
|
136
116
|
|
|
137
|
-
|
|
117
|
+
---
|
|
118
|
+
|
|
119
|
+
## Core Capabilities
|
|
120
|
+
|
|
121
|
+
### 1. Codebase Awareness & AST Mapping
|
|
122
|
+
RivoCode builds an abstract syntax tree (AST) map of your repository using WebAssembly Tree-Sitter grammars. It resolves functions, classes, type declarations, and imports across the entire workspace to provide accurate context.
|
|
123
|
+
|
|
124
|
+
### 2. Multi-File Atomic Editing
|
|
125
|
+
The agent constructs full structural modifications, validates diffs, and writes patches directly across multiple project files in a single pass.
|
|
126
|
+
|
|
127
|
+
### 3. Integrated Terminal & Tool Execution
|
|
128
|
+
RivoCode executes builds, linters, tests, and file system commands directly to verify implementations and self-correct runtime errors.
|
|
129
|
+
|
|
130
|
+
### 4. Zero-Latency Terminal UI
|
|
131
|
+
Powered by OpenTUI and React reconciler engines, RivoCode delivers syntax highlighting, markdown rendering, progress trackers, and real-time streaming tokens.
|
|
132
|
+
|
|
133
|
+
---
|
|
134
|
+
|
|
135
|
+
## AI Model Providers & Configuration
|
|
138
136
|
|
|
139
|
-
Set
|
|
137
|
+
Set provider API keys in your shell environment or a local `.env` file:
|
|
140
138
|
|
|
141
139
|
```bash
|
|
142
|
-
#
|
|
143
|
-
MINIMAX_API_KEY=
|
|
144
|
-
|
|
145
|
-
|
|
140
|
+
# MiniMax
|
|
141
|
+
export MINIMAX_API_KEY="your_minimax_api_key"
|
|
142
|
+
|
|
143
|
+
# Google Gemini
|
|
144
|
+
export GEMINI_API_KEY="your_gemini_api_key"
|
|
145
|
+
|
|
146
|
+
# Anthropic Claude
|
|
147
|
+
export ANTHROPIC_API_KEY="your_anthropic_api_key"
|
|
148
|
+
|
|
149
|
+
# OpenAI
|
|
150
|
+
export OPENAI_API_KEY="your_openai_api_key"
|
|
151
|
+
|
|
152
|
+
# OpenRouter
|
|
153
|
+
export OPENROUTER_API_KEY="your_openrouter_api_key"
|
|
146
154
|
```
|
|
147
155
|
|
|
148
|
-
|
|
156
|
+
---
|
|
149
157
|
|
|
150
|
-
|
|
158
|
+
## CLI Options & Execution Modes
|
|
159
|
+
|
|
160
|
+
| Option | Flag | Description |
|
|
161
|
+
| :--- | :--- | :--- |
|
|
162
|
+
| **Plan Mode** | `--plan` | Generates detailed architectural roadmaps before applying code changes |
|
|
163
|
+
| **Lite Mode** | `--lite` | Fast execution optimized for quick edits and single-file modifications |
|
|
164
|
+
| **Max Mode** | `--max` | Extended reasoning mode for complex refactoring tasks |
|
|
165
|
+
| **Continue Session** | `--continue [id]` | Resumes an active or previous conversation session |
|
|
166
|
+
| **Working Directory** | `--cwd <path>` | Sets the project root path explicitly |
|
|
167
|
+
| **Clear Logs** | `--clear-logs` | Cleans previous session logs before starting |
|
|
168
|
+
| **Version** | `-v, --version` | Outputs current CLI version |
|
|
169
|
+
| **Help** | `-h, --help` | Displays usage instructions |
|
|
170
|
+
|
|
171
|
+
### Execution Examples:
|
|
151
172
|
|
|
152
173
|
```bash
|
|
153
|
-
|
|
174
|
+
# Start in architectural planning mode
|
|
175
|
+
rivo --plan
|
|
176
|
+
|
|
177
|
+
# Run a quick fix in Lite mode
|
|
178
|
+
rivo --lite "Fix TypeScript error in user.service.ts"
|
|
179
|
+
|
|
180
|
+
# Continue the previous session
|
|
181
|
+
rivo --continue
|
|
154
182
|
```
|
|
155
183
|
|
|
156
|
-
|
|
184
|
+
---
|
|
185
|
+
|
|
186
|
+
## Interactive Chat Commands
|
|
187
|
+
|
|
188
|
+
Inside the active terminal session, use slash commands to manage your workflow:
|
|
189
|
+
|
|
190
|
+
| Command | Action |
|
|
191
|
+
| :--- | :--- |
|
|
192
|
+
| `/model` | Open interactive model switcher (MiniMax, Gemini, Claude, etc.) |
|
|
193
|
+
| `/help` | Display list of interactive commands and shortcuts |
|
|
194
|
+
| `/clear` | Clear active conversation history |
|
|
195
|
+
| `/attach <file>` | Attach specific file context into current prompt |
|
|
157
196
|
|
|
158
|
-
|
|
159
|
-
- `/model [name]` - Switch AI model (mini, llama, gemini)
|
|
160
|
-
- `/clear` - Clear conversation history
|
|
161
|
-
- `/attach [file]` - Attach file to message
|
|
197
|
+
---
|
|
162
198
|
|
|
163
|
-
|
|
199
|
+
## Architecture & Technology Stack
|
|
164
200
|
|
|
165
201
|
```
|
|
166
|
-
/
|
|
167
|
-
/
|
|
168
|
-
/
|
|
202
|
+
rivocode/
|
|
203
|
+
├── bin/ # Universal Node.js cross-platform launcher
|
|
204
|
+
├── cli/ # OpenTUI & React terminal application
|
|
205
|
+
│ ├── src/
|
|
206
|
+
│ │ ├── commands/ # CLI routing and command registration
|
|
207
|
+
│ │ ├── components/ # Terminal UI components
|
|
208
|
+
│ │ ├── hooks/ # Keyboard and lifecycle hooks
|
|
209
|
+
│ │ └── utils/ # AST indexing and terminal brokers
|
|
210
|
+
│ └── scripts/ # Cross-compilation scripts
|
|
211
|
+
├── sdk/ # Core RivoCode TypeScript SDK
|
|
212
|
+
└── packages/
|
|
213
|
+
├── agent-runtime/ # Agent loops and tool invocation execution
|
|
214
|
+
├── code-map/ # Tree-Sitter AST indexer
|
|
215
|
+
└── llm-providers/ # Multi-provider streaming adapter
|
|
169
216
|
```
|
|
170
217
|
|
|
171
|
-
|
|
218
|
+
- **Runtime & Compilation**: Bun `--compile` standalone cross-platform binaries
|
|
219
|
+
- **Terminal UI**: OpenTUI + React 19 + Yoga Layout engine
|
|
220
|
+
- **Code Parsing**: WebAssembly Tree-Sitter
|
|
221
|
+
- **Package Distribution**: npm registry wrapper with automated GitHub release retrieval
|
|
222
|
+
|
|
223
|
+
---
|
|
224
|
+
|
|
225
|
+
## Uninstallation
|
|
172
226
|
|
|
173
|
-
|
|
227
|
+
### Remove Global Package
|
|
174
228
|
|
|
175
|
-
|
|
229
|
+
```bash
|
|
230
|
+
# npm
|
|
231
|
+
npm uninstall -g @rivocode-cli/cli
|
|
232
|
+
|
|
233
|
+
# bun
|
|
234
|
+
bun remove -g @rivocode-cli/cli
|
|
235
|
+
|
|
236
|
+
# pnpm
|
|
237
|
+
pnpm remove -g @rivocode-cli/cli
|
|
238
|
+
|
|
239
|
+
# yarn
|
|
240
|
+
yarn global remove @rivocode-cli/cli
|
|
241
|
+
```
|
|
242
|
+
|
|
243
|
+
### Clean Binary Cache & Configuration
|
|
244
|
+
|
|
245
|
+
#### macOS & Linux:
|
|
246
|
+
```bash
|
|
247
|
+
rm -rf ~/.rivocode
|
|
248
|
+
```
|
|
249
|
+
|
|
250
|
+
#### Windows (PowerShell):
|
|
251
|
+
```powershell
|
|
252
|
+
Remove-Item -Recurse -Force ~/.rivocode
|
|
253
|
+
```
|
|
254
|
+
|
|
255
|
+
---
|
|
256
|
+
|
|
257
|
+
## License
|
|
176
258
|
|
|
177
|
-
|
|
259
|
+
This project is licensed under the [MIT License](LICENSE).
|
package/bin/rivo.js
CHANGED
|
@@ -9,6 +9,7 @@ import {
|
|
|
9
9
|
unlinkSync,
|
|
10
10
|
readFileSync,
|
|
11
11
|
renameSync,
|
|
12
|
+
readdirSync,
|
|
12
13
|
} from 'node:fs';
|
|
13
14
|
import { homedir, platform, arch } from 'node:os';
|
|
14
15
|
import { join, dirname } from 'node:path';
|
|
@@ -24,9 +25,9 @@ function getPackageVersion() {
|
|
|
24
25
|
try {
|
|
25
26
|
const pkgPath = join(__dirname, '..', 'package.json');
|
|
26
27
|
const pkg = JSON.parse(readFileSync(pkgPath, 'utf8'));
|
|
27
|
-
return pkg.version || '
|
|
28
|
+
return pkg.version || '2.0.0';
|
|
28
29
|
} catch {
|
|
29
|
-
return '
|
|
30
|
+
return '2.0.0';
|
|
30
31
|
}
|
|
31
32
|
}
|
|
32
33
|
|
|
@@ -93,6 +94,14 @@ function getTargetInfo() {
|
|
|
93
94
|
);
|
|
94
95
|
}
|
|
95
96
|
|
|
97
|
+
function safeUnlink(filePath) {
|
|
98
|
+
if (existsSync(filePath)) {
|
|
99
|
+
try {
|
|
100
|
+
unlinkSync(filePath);
|
|
101
|
+
} catch {}
|
|
102
|
+
}
|
|
103
|
+
}
|
|
104
|
+
|
|
96
105
|
function downloadFile(url, dest, maxRedirects = 5) {
|
|
97
106
|
return new Promise((resolve, reject) => {
|
|
98
107
|
if (maxRedirects < 0) {
|
|
@@ -130,12 +139,12 @@ function downloadFile(url, dest, maxRedirects = 5) {
|
|
|
130
139
|
});
|
|
131
140
|
|
|
132
141
|
fileStream.on('error', (err) => {
|
|
133
|
-
|
|
142
|
+
safeUnlink(dest);
|
|
134
143
|
reject(err);
|
|
135
144
|
});
|
|
136
145
|
})
|
|
137
146
|
.on('error', (err) => {
|
|
138
|
-
|
|
147
|
+
safeUnlink(dest);
|
|
139
148
|
reject(err);
|
|
140
149
|
});
|
|
141
150
|
});
|
|
@@ -201,19 +210,32 @@ async function ensureBinary() {
|
|
|
201
210
|
renameSync(rawBinaryPath, finalBinaryPath);
|
|
202
211
|
}
|
|
203
212
|
|
|
213
|
+
// Fallback search if target binary was not found directly at finalBinaryPath
|
|
214
|
+
if (!existsSync(finalBinaryPath)) {
|
|
215
|
+
const files = readdirSync(cacheBase);
|
|
216
|
+
const matched = files.find(
|
|
217
|
+
(f) => f.startsWith('rivo') && !f.endsWith('.tar.gz') && !f.endsWith('.zip')
|
|
218
|
+
);
|
|
219
|
+
if (matched) {
|
|
220
|
+
renameSync(join(cacheBase, matched), finalBinaryPath);
|
|
221
|
+
}
|
|
222
|
+
}
|
|
223
|
+
|
|
224
|
+
if (!existsSync(finalBinaryPath)) {
|
|
225
|
+
throw new Error(`Extracted binary was not found at ${finalBinaryPath}`);
|
|
226
|
+
}
|
|
227
|
+
|
|
204
228
|
if (!targetInfo.isWindows && existsSync(finalBinaryPath)) {
|
|
205
229
|
chmodSync(finalBinaryPath, 0o755);
|
|
206
230
|
}
|
|
207
231
|
|
|
208
232
|
// Clean up archive
|
|
209
|
-
|
|
210
|
-
unlinkSync(tempArchive);
|
|
211
|
-
}
|
|
233
|
+
safeUnlink(tempArchive);
|
|
212
234
|
|
|
213
235
|
return finalBinaryPath;
|
|
214
236
|
} catch (err) {
|
|
215
237
|
// Clean up on failure
|
|
216
|
-
|
|
238
|
+
safeUnlink(tempArchive);
|
|
217
239
|
throw new Error(
|
|
218
240
|
`Failed to install RivoCode v${VERSION}:\n${err.message}\n` +
|
|
219
241
|
`You can manually download the binary from: https://github.com/${GITHUB_REPO}/releases/tag/v${VERSION}`
|
package/package.json
CHANGED
|
@@ -1,9 +1,9 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@rivocode-cli/cli",
|
|
3
|
-
"version": "
|
|
3
|
+
"version": "2.0.1",
|
|
4
4
|
"description": "RivoCode — AI-powered terminal coding assistant",
|
|
5
5
|
"author": "Sanket Padhyal <mrsanketpadhyal@gmail.com>",
|
|
6
|
-
"license": "
|
|
6
|
+
"license": "MIT",
|
|
7
7
|
"type": "module",
|
|
8
8
|
"bin": {
|
|
9
9
|
"rivo": "bin/rivo.js",
|
|
@@ -47,11 +47,7 @@
|
|
|
47
47
|
"ci": "bun run build:sdk",
|
|
48
48
|
"typecheck": "bun --cwd cli typecheck"
|
|
49
49
|
},
|
|
50
|
-
"dependencies": {
|
|
51
|
-
"canvas": "^3.2.0",
|
|
52
|
-
"gif-encoder-2": "^1.0.5",
|
|
53
|
-
"zod": "^4.2.1"
|
|
54
|
-
},
|
|
50
|
+
"dependencies": {},
|
|
55
51
|
"overrides": {
|
|
56
52
|
"react": "^19.0.0",
|
|
57
53
|
"react-dom": "^19.0.0",
|
|
@@ -63,6 +59,8 @@
|
|
|
63
59
|
"signal-exit": "3.0.7"
|
|
64
60
|
},
|
|
65
61
|
"devDependencies": {
|
|
62
|
+
"canvas": "^3.2.0",
|
|
63
|
+
"gif-encoder-2": "^1.0.5",
|
|
66
64
|
"@tanstack/react-query": "^5.90.12",
|
|
67
65
|
"@types/bun": "1.3.11",
|
|
68
66
|
"@types/js-yaml": "^4.0.9",
|