vrcli 0.1.1

A command-line interface for the VRChat API that lets you manage friends, users, worlds, and authentication directly from your terminal
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100

<div align="center">
  <img src=".github/assets/logo.png" alt="vrcli logo" width="200">
</div>

# vrcli


<div align="center">

[![Crates.io](https://img.shields.io/crates/v/vrcli.svg)](https://crates.io/crates/vrcli) [![Downloads](https://img.shields.io/crates/d/vrcli.svg)](https://crates.io/crates/vrcli) [![License](https://img.shields.io/crates/l/vrcli.svg)](LICENSE) [![CI](https://github.com/VRCli/vrcli/workflows/CI/badge.svg)](https://github.com/VRCli/vrcli/actions) [![Rust Version](https://img.shields.io/badge/rustc-1.70+-blue.svg)](https://forge.rust-lang.org/infra/channel-releases.html)

</div>

A command-line interface for the VRChat API that lets you manage friends, users, worlds, and authentication directly from your terminal.

## Installation


First, install Rust (https://www.rust-lang.org/tools/install), then:

```powershell
cargo install vrcli
```

## Usage


Set up authentication:

```powershell
vrcli auth login
vrcli auth status
```

General syntax:

```
vrcli <resource> <action> [options]
```

## Commands(Simplified)


### Authentication

- `auth login` - Set authentication credentials
- `auth logout` - Logout and remove stored credentials
- `auth status` - Show current authentication status

### Users

- `users search <query>` - Search users by display name
- `users get <identifier>` - Get user information by ID or display name
  
### Friends

- `friends list` - List all friends with various filtering and sorting options
- `friends get <identifier>` - Get friend details by username
- `friends add <identifier>` - Send a friend request to a user
- `friends remove <identifier>` - Remove a friend or cancel outgoing friend request
- `friends status <identifier>` - Check friend status with a user

### Invites

- `invite send <user> <instance_id>` - Send an invite to a friend
- `invite request <user>` - Request an invite from a friend

### Worlds

- `worlds search <query>` - Search worlds
- `worlds get <world_id>` - Get world information by ID

### Common Options

Most commands support:
- `--id` - Use direct user ID instead of resolving display name
- `--json` - Output in JSON format
- `--long` / `-l` - Show detailed information

## Development


Clone the repo and install dependencies:

```powershell
git clone https://github.com/VRCli/vrcli
cd vrcli
cargo install cargo-husky
```

Standard workflow:

```powershell
# Build and test

cargo build
cargo test

# Format and lint

cargo fmt --all
cargo clippy --all-targets -- -D warnings
```

Pre-commit hooks run automatically via cargo-husky.

## Contributing


Contributions are welcome! Please fork the repo, create a branch, and submit a pull request.

## License


MIT