@augmentcode/auggie 0.3.0 → 0.5.0
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 +44 -0
- package/augment.mjs +934 -850
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,44 @@
|
|
|
1
|
+
# Auggie CLI
|
|
2
|
+
|
|
3
|
+
Auggie CLI takes the power of Augment's agent and context engine and puts it in your terminal,
|
|
4
|
+
allowing you to use Augment anywhere your code goes. You can use Auggie in a standalone interactive
|
|
5
|
+
terminal session alongside your favorite editor or in any part of your software development stack.
|
|
6
|
+
|
|
7
|
+
## Installation
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install -g @augmentcode/auggie
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
**Requirements:**
|
|
14
|
+
- Node.js 22 or later
|
|
15
|
+
- A compatible shell (zsh, bash, fish)
|
|
16
|
+
|
|
17
|
+
> **Note:** Auggie is currently in beta and may not run on all environments and terminal configurations.
|
|
18
|
+
|
|
19
|
+
## Quick Start
|
|
20
|
+
|
|
21
|
+
1. **Navigate to your project directory:**
|
|
22
|
+
```bash
|
|
23
|
+
cd /path/to/your/project
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
2. **Login to your Augment account:**
|
|
27
|
+
```bash
|
|
28
|
+
auggie login
|
|
29
|
+
```
|
|
30
|
+
|
|
31
|
+
3. **Start using Auggie:**
|
|
32
|
+
```bash
|
|
33
|
+
auggie "Give me a summary of this project"
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
## Documentation
|
|
37
|
+
|
|
38
|
+
For complete documentation, setup guides, and advanced usage, visit:
|
|
39
|
+
|
|
40
|
+
**📖 [https://docs.augmentcode.com/cli/overview](https://docs.augmentcode.com/cli/overview)**
|
|
41
|
+
|
|
42
|
+
## License
|
|
43
|
+
|
|
44
|
+
See LICENSE.md for license information.
|