Skip to content

Commit a78d099

Browse files
committed
docs: update installation methods with all new distribution channels
- Add comprehensive installation guide with npm, Homebrew, Scoop, Docker - Update release template with all installation methods - Prepare for v0.0.5 release with full multi-platform support
1 parent 8b15416 commit a78d099

File tree

3 files changed

+65
-12
lines changed

3 files changed

+65
-12
lines changed

.goreleaser.yaml

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -84,18 +84,32 @@ release:
8484
8585
### Installation
8686
87-
#### macOS/Linux
87+
#### npm (Cross-platform)
8888
```bash
89-
curl -sSL https://github.com/VapiAI/cli/releases/download/v{{.Version}}/vapi_$(uname -s)_$(uname -m).tar.gz | tar xz
90-
sudo mv vapi /usr/local/bin
89+
npm install -g @vapi-ai/cli
9190
```
9291
93-
#### Windows
94-
Download the Windows archive from the assets below and add to your PATH.
92+
#### Homebrew (macOS/Linux)
93+
```bash
94+
brew tap vapi/tap && brew install vapi-cli
95+
```
96+
97+
#### Scoop (Windows)
98+
```powershell
99+
scoop bucket add vapi https://github.com/VapiAI/scoop-bucket
100+
scoop install vapi-cli
101+
```
95102
96-
#### Homebrew (coming soon)
103+
#### Docker
97104
```bash
98-
brew install vapi/tap/vapi-cli
105+
docker run -it ghcr.io/vapiai/cli:latest --help
106+
```
107+
108+
#### Direct Download
109+
```bash
110+
# macOS/Linux
111+
curl -sSL https://github.com/VapiAI/cli/releases/download/v{{.Version}}/cli_$(uname -s)_$(uname -m).tar.gz | tar xz
112+
sudo mv vapi /usr/local/bin
99113
```
100114
101115
footer: |

README.md

Lines changed: 43 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,49 @@ The official command-line interface for [Vapi](https://vapi.ai) - Voice AI for d
2323

2424
## Installation
2525

26+
### npm (Cross-platform)
27+
28+
```bash
29+
npm install -g @vapi-ai/cli
30+
```
31+
32+
### Homebrew (macOS/Linux)
33+
34+
```bash
35+
brew tap vapi/tap
36+
brew install vapi-cli
37+
```
38+
39+
### Scoop (Windows)
40+
41+
```powershell
42+
scoop bucket add vapi https://github.com/VapiAI/scoop-bucket
43+
scoop install vapi-cli
44+
```
45+
46+
### Docker
47+
48+
```bash
49+
# Run directly
50+
docker run -it ghcr.io/vapiai/cli:latest --help
51+
52+
# Or with persistent config
53+
docker run -it -v ~/.vapi-cli.yaml:/home/vapi/.vapi-cli.yaml ghcr.io/vapiai/cli:latest assistant list
54+
```
55+
56+
### Direct Download
57+
58+
Download pre-built binaries from [GitHub Releases](https://github.com/VapiAI/cli/releases):
59+
60+
```bash
61+
# macOS/Linux
62+
curl -sSL https://github.com/VapiAI/cli/releases/latest/download/cli_$(uname -s)_$(uname -m).tar.gz | tar xz
63+
sudo mv vapi /usr/local/bin
64+
65+
# Or download specific version
66+
curl -sSL https://github.com/VapiAI/cli/releases/download/v0.0.6/cli_Darwin_arm64.tar.gz | tar xz
67+
```
68+
2669
### From Source
2770

2871
```bash
@@ -40,10 +83,6 @@ make build
4083
make install
4184
```
4285

43-
### Binary Releases
44-
45-
Coming soon: Pre-built binaries for macOS, Linux, and Windows.
46-
4786
## Development Requirements
4887

4988
- **Go 1.21+** - [Install Go](https://golang.org/doc/install)

VERSION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
0.0.4
1+
0.0.5

0 commit comments

Comments
 (0)