Skip to content

Commit 95a6bcd

Browse files
Revise README for clarity and updated commands
Updated installation instructions and fixed formatting issues in README.
1 parent e575a89 commit 95a6bcd

1 file changed

Lines changed: 46 additions & 16 deletions

File tree

README.md

Lines changed: 46 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -11,9 +11,9 @@
1111

1212
</div>
1313

14-
- **Multi-agent terminal coding harness** — plan → questions → confirm → execute → accept.
14+
**Multi-agent terminal coding harness** — plan → questions → confirm → execute → accept.
1515

16-
> Four agents (**ORCH · FE · BE · QA**) work in parallel, can spawn swarm workers, use **25+ tools**, and support **per-agent APIs/models**.
16+
Four agents (**ORCH · FE · BE · QA**) work in parallel, can spawn swarm workers, use **25+ tools**, and support **per-agent APIs/models**.
1717

1818
| Doc | Contents |
1919
|-----|----------|
@@ -61,28 +61,58 @@
6161

6262
## Install
6363

64-
### From a clone
64+
### One-liner (recommended)
65+
66+
**Linux / macOS / WSL (`install.sh`)**
6567

6668
```bash
67-
git clone https://github.com/YOUR_USER/arrowcode.git
68-
cd arrowcode
69-
chmod +x install.sh bin/arrowcode
70-
./install.sh
71-
# or without install script:
72-
bun install
73-
bun link # optional global arrowcode / ac
69+
curl -fsSL https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.sh | bash
7470
```
7571

76-
### One-liner (after you publish)
72+
Install + open API setup wizard:
7773

7874
```bash
79-
# Linux / macOS / WSL — replace YOUR_USER
80-
curl -fsSL https://raw.githubusercontent.com/YOUR_USER/arrowcode/main/install.sh | bash
75+
curl -fsSL https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.sh | bash -s -- --setup
8176
```
8277

78+
**Windows PowerShell (`install.ps1`)**
79+
80+
```powershell
81+
irm https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.ps1 | iex
82+
```
83+
84+
Install + API setup wizard:
85+
8386
```powershell
84-
# Windows PowerShell
85-
irm https://raw.githubusercontent.com/YOUR_USER/arrowcode/main/install.ps1 | iex
87+
& ([scriptblock]::Create((irm https://raw.githubusercontent.com/Chintanpatel24/arrowcode/main/install.ps1))) -Setup
88+
```
89+
90+
Or clone first, then:
91+
92+
```powershell
93+
git clone https://github.com/Chintanpatel24/arrowcode.git
94+
cd arrowcode
95+
.\install.ps1 -Setup
96+
```
97+
98+
What the one-liners do:
99+
100+
1. Install Bun if missing
101+
2. Clone/update ArrowCode
102+
3. `bun install`
103+
4. Seed `~/.arrowcode` from `defaults/`
104+
5. Link `arrowcode` / `ac` onto your PATH
105+
106+
### From a clone
107+
108+
```bash
109+
git clone https://github.com/Chintanpatel24/arrowcode.git
110+
cd arrowcode
111+
chmod +x install.sh bin/arrowcode
112+
./install.sh
113+
# or without install script:
114+
bun install
115+
bun link # optional global arrowcode / ac
86116
```
87117

88118
### Setup API key
@@ -93,7 +123,7 @@ arrowcode --setup
93123
export NVIDIA_API_KEY=nvapi-...
94124
```
95125

96-
`~/.arrowcode` is created **only** by `--setup`, `--init`, or `./install.sh` (copied from `defaults/`).
126+
`~/.arrowcode` is created **only** by `--setup`, `--init`, or `./install.sh` / `install.ps1` (copied from `defaults/`).
97127

98128
---
99129

0 commit comments

Comments
 (0)