Skip to content

Commit

Permalink
Update installation instructions. v0.8.1
Browse files Browse the repository at this point in the history
  • Loading branch information
davidzhao committed May 25, 2022
1 parent 7f74460 commit d7bc6cb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 11 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,27 +9,31 @@ This package includes command line utilities that interacts with LiveKit. It all

## Installation

This repo uses Git LFS for embedded video resources. Please ensure git-lfs is installed on your machine.
You can download [latest release here](https://github.com/livekit/livekit-cli/releases/latest).

### Building from source

This repo uses [Git LFS](https://git-lfs.github.com/) for embedded video resources. Please ensure git-lfs is installed on your machine.

```shell
$ go install github.com/livekit/livekit-cli/cmd/livekit-cli@latest
$ go install github.com/livekit/livekit-cli/cmd/livekit-load-tester@latest
git clone github.com/livekit/livekit-cli
make install
```

## Usage

## livekit-cli

```shell
% ./bin/livekit-cli --help
% livekit-cli --help
NAME:
livekit-cli - CLI client to LiveKit

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

VERSION:
0.7.2
0.8.1

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

```shell
% ./bin/livekit-cli join-room --room yourroom --identity publisher \
% livekit-cli join-room --room yourroom --identity publisher \
--publish-demo
```

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

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

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

```shell
$ ./livekit-cli create-token --join --api-key <key> --api-secret <secret> \
$ livekit-cli create-token --join --api-key <key> --api-secret <secret> \
--room test-room --identity user
```

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

```shell
$ ./livekit-load-tester --url <your-url> \
$ livekit-load-tester --url <your-url> \
--api-key <key> \
--api-secret <secret> \
--duration 1m \
Expand Down
2 changes: 1 addition & 1 deletion version.go
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
package livekit_cli

const (
Version = "0.8.0"
Version = "0.8.1"
)

0 comments on commit d7bc6cb

Please sign in to comment.