Skip to content

Commit d7bc6cb

Browse files
committed
Update installation instructions. v0.8.1
1 parent 7f74460 commit d7bc6cb

File tree

2 files changed

+15
-11
lines changed

2 files changed

+15
-11
lines changed

README.md

Lines changed: 14 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,27 +9,31 @@ This package includes command line utilities that interacts with LiveKit. It all
99

1010
## Installation
1111

12-
This repo uses Git LFS for embedded video resources. Please ensure git-lfs is installed on your machine.
12+
You can download [latest release here](https://github.com/livekit/livekit-cli/releases/latest).
13+
14+
### Building from source
15+
16+
This repo uses [Git LFS](https://git-lfs.github.com/) for embedded video resources. Please ensure git-lfs is installed on your machine.
1317

1418
```shell
15-
$ go install github.com/livekit/livekit-cli/cmd/livekit-cli@latest
16-
$ go install github.com/livekit/livekit-cli/cmd/livekit-load-tester@latest
19+
git clone github.com/livekit/livekit-cli
20+
make install
1721
```
1822

1923
## Usage
2024

2125
## livekit-cli
2226

2327
```shell
24-
% ./bin/livekit-cli --help
28+
% livekit-cli --help
2529
NAME:
2630
livekit-cli - CLI client to LiveKit
2731

2832
USAGE:
2933
livekit-cli [global options] command [command options] [arguments...]
3034

3135
VERSION:
32-
0.7.2
36+
0.8.1
3337

3438
COMMANDS:
3539
help, h Shows a list of commands or help for one command
@@ -76,7 +80,7 @@ GLOBAL OPTIONS:
7680
To publish a demo video as a participant's track, use the following.
7781

7882
```shell
79-
% ./bin/livekit-cli join-room --room yourroom --identity publisher \
83+
% livekit-cli join-room --room yourroom --identity publisher \
8084
--publish-demo
8185
```
8286

@@ -88,7 +92,7 @@ You can publish your own audio/video files. These tracks files need to be encode
8892
Refer to [encoding instructions](https://github.com/livekit/server-sdk-go/tree/main#publishing-tracks-to-room)
8993

9094
```shell
91-
% ./bin/livekit-cli join-room --room yourroom --identity publisher \
95+
% livekit-cli join-room --room yourroom --identity publisher \
9296
--publish path/to/video.ivf \
9397
--publish path/to/audio.ogg \
9498
--fps 23.98
@@ -122,7 +126,7 @@ Load testing utility for LiveKit. This tool is quite versatile and is able to si
122126
This guide requires a LiveKit server instance to be set up. You can start a load tester with:
123127

124128
```shell
125-
$ ./livekit-load-tester --url <your-url> \
129+
$ livekit-load-tester --url <your-url> \
126130
--api-key <key> --api-secret <secret> \
127131
--room test-room --publishers 24
128132
```
@@ -134,7 +138,7 @@ This simulates 8 video publishers to the room, with no subscribers. Video tracks
134138
Use `livekit-cli` to generate a token so you can log into the room:
135139

136140
```shell
137-
$ ./livekit-cli create-token --join --api-key <key> --api-secret <secret> \
141+
$ livekit-cli create-token --join --api-key <key> --api-secret <secret> \
138142
--room test-room --identity user
139143
```
140144

@@ -174,7 +178,7 @@ of data sent to its subscribers.
174178
Use this command to simulate a load test of 5 publishers, and 500 subscribers:
175179

176180
```shell
177-
$ ./livekit-load-tester --url <your-url> \
181+
$ livekit-load-tester --url <your-url> \
178182
--api-key <key> \
179183
--api-secret <secret> \
180184
--duration 1m \

version.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
package livekit_cli
22

33
const (
4-
Version = "0.8.0"
4+
Version = "0.8.1"
55
)

0 commit comments

Comments
 (0)