Package: bitscreen-cli
BitScreen CLI GuideInstallationpip install bitscreen-cliFirst stepsBefore starting to interact with BitScreen, you should first log in. You can do this two ways:Using a private keyTo obtain your private key from Metamask, you can check outthistutorial.$bitscreen-cliauthloginWhat's you Ethereum wallet address?: <your wallet address>What's your private key?: <your private key>Using a mnemonic/seed phraseTo obtain your seed phrase from Metamask, you can check outthistutorial.$bitscreen-cliauthlogin--from-seedPlease 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.DocumentationUsage:$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:authciddashboarddirectoryfiltersettingssetupbitscreen-cli authUsage:$bitscreen-cliauth[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:loginlogoutregisterbitscreen-cli auth loginUsage:$bitscreen-cliauthlogin[OPTIONS]Options:--fromseed: Will require a seed phrase.--help: Show this message and exit.bitscreen-cli auth logoutUsage:$bitscreen-cliauthlogout[OPTIONS]Options:--help: Show this message and exit.bitscreen-cli auth registerUsage:$bitscreen-cliauthregister[OPTIONS]WALLETArguments:WALLET: [required]Options:--help: Show this message and exit.bitscreen-cli setupUsage:$bitscreen-clisetup[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:installbitscreen-cli setup installUsage:$bitscreen-clisetupinstallbitscreen-cli cidUsage:$bitscreen-clicid[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:list_blockedbitscreen-cli cid list_blockedUsage:$bitscreen-clicidlist_blocked[OPTIONS]Options:-o, --outputfile TEXT--help: Show this message and exit.bitscreen-cli dashboardUsage:$bitscreen-clidashboard[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:showbitscreen-cli dashboard showUsage:$bitscreen-clidashboardshow[OPTIONS]Options:--help: Show this message and exit.bitscreen-cli directoryUsage:$bitscreen-clidirectory[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:detailsdiscardimportlist_blockedbitscreen-cli directory detailsUsage:$bitscreen-clidirectorydetails[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli directory discardUsage:$bitscreen-clidirectorydiscard[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli directory importUsage:$bitscreen-clidirectoryimport[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli directory listUsage:$bitscreen-clidirectorylist[OPTIONS]Options:--search TEXT: [default: ]--help: Show this message and exit.bitscreen-cli filterUsage:$bitscreen-clifilter[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:addadd-ciddeletedetailsdisableeditenablelistremove-cidbitscreen-cli filter addUsage:$bitscreen-clifilteradd[OPTIONS]Options:--name TEXT: [required]--description TEXT: [required]--visibility TEXT: [required]--override INTEGER: [required]--help: Show this message and exit.bitscreen-cli filter add-cidUsage:$bitscreen-clifilteradd-cid[OPTIONS]FILTERCIDArguments:FILTER: [required]CID: [required]Options:--refurl TEXT: [default: ]--help: Show this message and exit.bitscreen-cli filter deleteUsage:$bitscreen-clifilterdelete[OPTIONS]FILTERArguments:FILTER: [required]Options:--confirm / --no-confirm: [default: False]--help: Show this message and exit.bitscreen-cli filter detailsUsage:$bitscreen-clifilterdetails[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli filter disableUsage:$bitscreen-clifilterdisable[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli filter editUsage:$bitscreen-clifilteredit[OPTIONS]FILTERArguments:FILTER: [required]Options:--name TEXT--description TEXT--override INTEGER--visibility TEXT--help: Show this message and exit.bitscreen-cli filter enableUsage:$bitscreen-clifilterenable[OPTIONS]FILTERArguments:FILTER: [required]Options:--help: Show this message and exit.bitscreen-cli filter listUsage:$bitscreen-clifilterlist[OPTIONS]Options:--search TEXT: [default: ]--help: Show this message and exit.bitscreen-cli filter remove-cidUsage:$bitscreen-clifilterremove-cid[OPTIONS]FILTERCIDArguments:FILTER: [required]CID: [required]Options:--help: Show this message and exit.bitscreen-cli settingsUsage:$bitscreen-clisettings[OPTIONS]COMMAND[ARGS]...Options:--help: Show this message and exit.Commands:disableenablegetsetbitscreen-cli settings disableUsage:$bitscreen-clisettingsdisable[OPTIONS]ACTION:[filtering|sharing|importing]Arguments:ACTION:[filtering|sharing|importing]: [required]Options:--help: Show this message and exit.bitscreen-cli settings enableUsage:$bitscreen-clisettingsenable[OPTIONS]ACTION:[filtering|sharing|importing]Arguments:ACTION:[filtering|sharing|importing]: [required]Options:--help: Show this message and exit.bitscreen-cli settings getUsage:$bitscreen-clisettingsget[OPTIONS]Options:--help: Show this message and exit.bitscreen-cli settings setUsage:$bitscreen-clisettingsset[OPTIONS]KEY:[country|name|website|email|contact-person|address]VALUEArguments:KEY:[country|name|website|email|contact-person|address]: [required]VALUE: [required]Options:--help: Show this message and exit.