diff --git a/docs/cli.md b/docs/cli.md index 82a2622a5..3253edfe3 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -144,7 +144,7 @@ Return: ## claim_list ```text -Get claims for a name +List current claims and information about them for a given name Usage: claim_list ( | --name=) @@ -171,6 +171,58 @@ Returns } ``` +## claim_list_by_channel + +```text +Get paginated claims in a channel specified by a channel uri + +Usage: + claim_list_by_channel ( | --uri=) [...] [--page=] + [--page_size=] + +Options: + --page= : which page of results to return where page 1 is the first + page, defaults to no pages + --page_size= : number of results in a page, default of 10 + +Returns: + { + resolved channel uri: { + If there was an error: + 'error': (str) error message + + 'claims_in_channel_pages': total number of pages with results, + + If a page of results was requested: + 'returned_page': page number returned, + 'claims_in_channel': [ + { + 'absolute_channel_position': (int) claim index number in sorted list of + claims which assert to be part of the + channel + 'address': (str) claim address, + 'amount': (float) claim amount, + 'effective_amount': (float) claim amount including supports, + 'claim_id': (str) claim id, + 'claim_sequence': (int) claim sequence number, + 'decoded_claim': (bool) whether or not the claim value was decoded, + 'height': (int) claim height, + 'depth': (int) claim depth, + 'has_signature': (bool) included if decoded_claim + 'name': (str) claim name, + 'supports: (list) list of supports [{'txid': txid, + 'nout': nout, + 'amount': amount}], + 'txid': (str) claim txid, + 'nout': (str) claim nout, + 'signature_is_valid': (bool), included if has_signature, + 'value': ClaimDict if decoded, otherwise hex string + } + ], + } + } +``` + ## claim_list_mine ```text @@ -219,6 +271,21 @@ Return: } ``` +## claim_send_to_address + +```text +Send a name claim to an address + +Usage: + claim_send_to_address ( | --claim_id=) + (
| --address=
) + [ | --amount=] + +Options: + : Amount of credits to claim name for, defaults to the current amount + on the claim +``` + ## claim_show ```text @@ -253,14 +320,15 @@ Returns: ```text This command is only for testing the CLI argument parsing Usage: - cli_test_command ( | --pos_arg=) + cli_test_command [-a] [-b] ( | --pos_arg=) [...] [--pos_arg2=] [--pos_arg3=] Options: + -a, --a_arg : a arg + -b, --b_arg : b arg , --pos_arg2= : pos arg 2 , --pos_arg3= : pos arg 3 - Returns: pos args ``` @@ -295,21 +363,24 @@ Returns: Delete a LBRY file Usage: - file_delete [-a | -f] [--sd_hash=] [--file_name=] + file_delete [-f] [--delete_all] [--sd_hash=] [--file_name=] [--stream_hash=] [--claim_id=] [--outpoint=] [--rowid=] [--name=] Options: - -a : delete file from downloads and delete stored blobs - -f : delete only from downloads, do not delete blobs - --sd_hash= : delete by file sd hash - --file_name : delete by file name in downloads folder - --stream_hash= : delete by file stream hash - --claim_id= : delete by file claim id - --outpoint= : delete by file claim outpoint - --rowid= : delete by file row id - --name= : delete by associated name claim of file + -f, --delete_from_download_dir : delete file from download directory, + instead of just deleting blobs + --delete_all : if there are multiple matching files, + allow the deletion of multiple files. + Otherwise do not delete anything. + --sd_hash= : delete by file sd hash + --file_name : delete by file name in downloads folder + --stream_hash= : delete by file stream hash + --claim_id= : delete by file claim id + --outpoint= : delete by file claim outpoint + --rowid= : delete by file row id + --name= : delete by associated name claim of file Returns: (bool) true if deletion was successful @@ -498,7 +569,7 @@ Usage: [--license=] [--license_url=] [--thumbnail=] [--preview=] [--nsfw=] [--sources=] [--channel_name=] [--channel_id=] - [--claim_address=] + [--claim_address=] [--change_address=] Options: --metadata= : ClaimDict to associate with the claim. @@ -571,39 +642,22 @@ Returns: ## resolve ```text -Resolve a LBRY URI +Resolve given LBRY URIs Usage: - resolve [-f] + resolve [-f] ( | --uri=) [...] Options: -f : force refresh and ignore cache Returns: - None if nothing can be resolved, otherwise: - If uri resolves to a channel or a claim in a channel: - 'certificate': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'supports: (list) list of supports [{'txid': txid, - 'nout': nout, - 'amount': amount}], - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string - } - If uri resolves to a channel: - 'claims_in_channel': [ - { + Dictionary of results, keyed by uri + '': { + If a resolution error occurs: + 'error': Error message + + If the uri resolves to a channel or a claim in a channel: + 'certificate': { 'address': (str) claim address, 'amount': (float) claim amount, 'effective_amount': (float) claim amount including supports, @@ -622,28 +676,28 @@ Returns: 'signature_is_valid': (bool), included if has_signature, 'value': ClaimDict if decoded, otherwise hex string } - ] - If uri resolves to a claim: - 'claim': { - 'address': (str) claim address, - 'amount': (float) claim amount, - 'effective_amount': (float) claim amount including supports, - 'claim_id': (str) claim id, - 'claim_sequence': (int) claim sequence number, - 'decoded_claim': (bool) whether or not the claim value was decoded, - 'height': (int) claim height, - 'depth': (int) claim depth, - 'has_signature': (bool) included if decoded_claim - 'name': (str) claim name, - 'channel_name': (str) channel name if claim is in a channel - 'supports: (list) list of supports [{'txid': txid, - 'nout': nout, - 'amount': amount}] - 'txid': (str) claim txid, - 'nout': (str) claim nout, - 'signature_is_valid': (bool), included if has_signature, - 'value': ClaimDict if decoded, otherwise hex string - } + + If the uri resolves to a claim: + 'claim': { + 'address': (str) claim address, + 'amount': (float) claim amount, + 'effective_amount': (float) claim amount including supports, + 'claim_id': (str) claim id, + 'claim_sequence': (int) claim sequence number, + 'decoded_claim': (bool) whether or not the claim value was decoded, + 'height': (int) claim height, + 'depth': (int) claim depth, + 'has_signature': (bool) included if decoded_claim + 'name': (str) claim name, + 'channel_name': (str) channel name if claim is in a channel + 'supports: (list) list of supports [{'txid': txid, + 'nout': nout, + 'amount': amount}] + 'txid': (str) claim txid, + 'nout': (str) claim nout, + 'signature_is_valid': (bool), included if has_signature, + 'value': ClaimDict if decoded, otherwise hex string + } } ``` @@ -718,6 +772,46 @@ Usage: Options: -s : include session status in results -d : include dht network and peer status + +Returns: + (dict) lbrynet-daemon status + { + 'lbry_id': lbry peer id, base58 + 'installation_id': installation id, base58 + 'is_running': bool + 'is_first_run': bool + 'startup_status': { + 'code': status code + 'message': status message + }, + 'connection_status': { + 'code': connection status code + 'message': connection status message + }, + 'blockchain_status': { + 'blocks': local blockchain height, + 'blocks_behind': remote_height - local_height, + 'best_blockhash': block hash of most recent block, + }, + + If given the session status option: + 'session_status': { + 'managed_blobs': count of blobs in the blob manager, + 'managed_streams': count of streams in the file manager + } + + If given the dht status option: + 'dht_status': { + 'kbps_received': current kbps receiving, + 'kbps_sent': current kdps being sent, + 'total_bytes_sent': total bytes sent + 'total_bytes_received': total bytes received + 'queries_received': number of queries received per second + 'queries_sent': number of queries sent per second + 'recent_contacts': count of recently contacted peers + 'unique_contacts': count of unique peers + } + } ``` ## stream_cost_estimate