CLI client for BitScreen
Project description
BitScreen CLI
Installation
pip install bitscreen-cli
First steps
Before starting to interact with BitScreen, you should first log in. You can do this two ways:
Using a private key
To obtain your private key from Metamask, you can check out this tutorial.
$ bitscreen-cli auth login
What's you Ethereum wallet address?: <your wallet address>
What's your private key?: <your private key>
Using a mnemonic/seed phrase
To obtain your seed phrase from Metamask, you can check out this tutorial.
$ bitscreen-cli auth login --from-seed
Please provide your seed phrase: <your seed phrase>
No matter which one of there two methods you pick, you will be asked if you want these credentials to be saved (locally) for future logins. These credentials are never leaving your machine through BitScreen CLI, they are only used to sign messages locally.
Documentation
Usage:
$ bitscreen-cli [OPTIONS] COMMAND [ARGS]...
Options:
--install-completion
: Install completion for the current shell.--show-completion
: Show completion for the current shell, to copy it or customize the installation.--help
: Show this message and exit.
Commands:
auth
cid
dashboard
directory
filter
settings
setup
bitscreen-cli auth
Usage:
$ bitscreen-cli auth [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
login
logout
register
bitscreen-cli auth login
Usage:
$ bitscreen-cli auth login [OPTIONS]
Options:
--fromseed / --no-fromseed
: [default: False]--help
: Show this message and exit.
bitscreen-cli auth logout
Usage:
$ bitscreen-cli auth logout [OPTIONS]
Options:
--help
: Show this message and exit.
bitscreen-cli auth register
Usage:
$ bitscreen-cli auth register [OPTIONS] WALLET
Arguments:
WALLET
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli setup
Usage:
$ bitscreen-cli setup [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
install
bitscreen-cli setup install
Usage:
$ bitscreen-cli setup install
bitscreen-cli cid
Usage:
$ bitscreen-cli cid [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
list
bitscreen-cli cid list
Usage:
$ bitscreen-cli cid list [OPTIONS]
Options:
-o, --outputfile TEXT
--help
: Show this message and exit.
bitscreen-cli dashboard
Usage:
$ bitscreen-cli dashboard [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
show
bitscreen-cli dashboard show
Usage:
$ bitscreen-cli dashboard show [OPTIONS]
Options:
--help
: Show this message and exit.
bitscreen-cli directory
Usage:
$ bitscreen-cli directory [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
details
discard
import
list
bitscreen-cli directory details
Usage:
$ bitscreen-cli directory details [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli directory discard
Usage:
$ bitscreen-cli directory discard [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli directory import
Usage:
$ bitscreen-cli directory import [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli directory list
Usage:
$ bitscreen-cli directory list [OPTIONS]
Options:
--search TEXT
: [default: ]--help
: Show this message and exit.
bitscreen-cli filter
Usage:
$ bitscreen-cli filter [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
add
add-cid
delete
details
disable
edit
enable
list
remove-cid
bitscreen-cli filter add
Usage:
$ bitscreen-cli filter add [OPTIONS]
Options:
--name TEXT
: [required]--description TEXT
: [required]--visibility TEXT
: [required]--override INTEGER
: [required]--help
: Show this message and exit.
bitscreen-cli filter add-cid
Usage:
$ bitscreen-cli filter add-cid [OPTIONS] FILTER CID
Arguments:
FILTER
: [required]CID
: [required]
Options:
--refurl TEXT
: [default: ]--help
: Show this message and exit.
bitscreen-cli filter delete
Usage:
$ bitscreen-cli filter delete [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--confirm / --no-confirm
: [default: False]--help
: Show this message and exit.
bitscreen-cli filter details
Usage:
$ bitscreen-cli filter details [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli filter disable
Usage:
$ bitscreen-cli filter disable [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli filter edit
Usage:
$ bitscreen-cli filter edit [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--name TEXT
--description TEXT
--override INTEGER
--visibility TEXT
--help
: Show this message and exit.
bitscreen-cli filter enable
Usage:
$ bitscreen-cli filter enable [OPTIONS] FILTER
Arguments:
FILTER
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli filter list
Usage:
$ bitscreen-cli filter list [OPTIONS]
Options:
--search TEXT
: [default: ]--help
: Show this message and exit.
bitscreen-cli filter remove-cid
Usage:
$ bitscreen-cli filter remove-cid [OPTIONS] FILTER CID
Arguments:
FILTER
: [required]CID
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli settings
Usage:
$ bitscreen-cli settings [OPTIONS] COMMAND [ARGS]...
Options:
--help
: Show this message and exit.
Commands:
disable
enable
get
set
bitscreen-cli settings disable
Usage:
$ bitscreen-cli settings disable [OPTIONS] ACTION:[filtering|sharing|importing]
Arguments:
ACTION:[filtering|sharing|importing]
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli settings enable
Usage:
$ bitscreen-cli settings enable [OPTIONS] ACTION:[filtering|sharing|importing]
Arguments:
ACTION:[filtering|sharing|importing]
: [required]
Options:
--help
: Show this message and exit.
bitscreen-cli settings get
Usage:
$ bitscreen-cli settings get [OPTIONS]
Options:
--help
: Show this message and exit.
bitscreen-cli settings set
Usage:
$ bitscreen-cli settings set [OPTIONS] KEY:[country|name|website|email|contact-person|address] VALUE
Arguments:
KEY:[country|name|website|email|contact-person|address]
: [required]VALUE
: [required]
Options:
--help
: Show this message and exit.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for bitscreen_cli-0.1.11-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | eb87ad55a9f8301bf999188f277bbbea13800790349d3aef98bbd9daf31da2e4 |
|
MD5 | a4dba0732c5f9d3714dc073589c4260b |
|
BLAKE2b-256 | 6c1cb49d91c0565651fb683fe7cc54fb7127fdf8f445f7728e1eb856408b3d9c |