Install

One-line install (Linux / macOS, recommended)

Ubuntu / Debian (recommended forsystemd support)

Cargo

Download binary

Usage

$bitsrun login -u<username> -p<password>bitsrun: <ip> (<username>) logged in$bitsrunlogout -u<username>bitsrun: <ip> logged out

$bitsrun statusbitsrun: <ip> (<username>) is online┌────────────────┬───────────────┬───────────────┬─────────┐│ Traffic Used   │ Online Time   │ User Balance  │ Wallet  │├────────────────┼───────────────┼───────────────┼─────────┤│ 188.10 GiB     │ 2 months      │ 10.00         │ 0.00    │└────────────────┴───────────────┴───────────────┴─────────┘

$bitsrun keep-alive INFO  bitsrun::daemon > starting daemon (<username>) with polling interval=3600s INFO  bitsrun::daemon > <ip> (<username>): login success, ... ^C INFO  bitsrun::daemon > <username>: gracefully exiting

Note

Use available system service managers to runbitsrun keep-alive as a daemon. (e.g.,systemd for Linux,launchd for macOS, and Windows Service for Windows).

Available commands

$bitsrun --helpA headless login and logout CLI for 10.0.0.55 at BITUsage: bitsrun [OPTIONS] [COMMAND]Commands:  login         Login to the campus network  logout        Logout from the campus network  status        Check device login status  config-paths  List all possible config file paths  keep-alive    Poll the server with login requests to keep the session alive  help          Print this message or the help of the given subcommand(s)Options:  -v, --verbose  Verbose output  -h, --help     Print help  -V, --version  Print version

Tip

Use environment variableNO_COLOR=true to disable colored output.

Config and credentials

{"username":"<username>","password":"<password>","dm":true,"poll_interval":3600}

$bitsrun config-pathsbitsrun: list of possible config paths┌──────────┬─────────────────────────────────────────────────────────────┐│ Priority │ Possible Config Path                                        │├──────────┼─────────────────────────────────────────────────────────────┤│ 1        │ /Users/spencerwoo/.config/bit-user.json                     ││ 2        │ /Users/spencerwoo/.config/bitsrun/bit-user.json             ││ 3        │ /Users/spencerwoo/Library/Preferences/bitsrun/bit-user.json ││ 4        │ bit-user.json                                               │└──────────┴─────────────────────────────────────────────────────────────┘

Note

The config file location is OS-dependent. Run the command to check the accepted locations on your system.

$chmod 600<path/to/bit-user.json>

Related

License