diff --git a/docs/cli.md b/docs/cli.md index bc902c836..fb4b526e5 100644 --- a/docs/cli.md +++ b/docs/cli.md @@ -109,16 +109,42 @@ Returns: (dict) Requested block ``` -## channel_list_mine +## channel_export ```text -Get my channels +Export serialized channel signing information for a given certificate claim id Usage: - channel_list_mine + channel_export ( | --claim_id=) Returns: - (list) ClaimDict + (str) Serialized certificate information +``` + +## channel_import + +```text +Import serialized channel signing information (to allow signing new claims to the channel) + +Usage: + channel_import ( | + --serialized_certificate_info=) + +Returns: + (dict) Result dictionary +``` + +## channel_list + +```text +Get certificate claim infos for channels that can be published to + +Usage: + channel_list + +Returns: + (list) ClaimDict, includes 'is_mine' field to indicate if the certificate claim + is in the wallet. ``` ## channel_new @@ -388,9 +414,7 @@ Delete a LBRY file Usage: file_delete [-f] [--delete_all] [--sd_hash=] [--file_name=] - [--stream_hash=] [--claim_id=] - [--outpoint=] [--rowid=] - [--name=] + [--stream_hash=] [--rowid=] Options: -f, --delete_from_download_dir : delete file from download directory, @@ -401,10 +425,7 @@ Options: --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 @@ -417,8 +438,7 @@ List files limited by optional filters Usage: file_list [--sd_hash=] [--file_name=] [--stream_hash=] - [--claim_id=] [--outpoint=] [--rowid=] - [--name=] + [--rowid=] [-f] Options: @@ -426,10 +446,7 @@ Options: --file_name= : get file with matching file name in the downloads folder --stream_hash= : get file with matching stream hash - --claim_id= : get file with matching claim id - --outpoint= : get file with matching claim outpoint --rowid= : get file with matching row id - --name= : get file with matching associated name claim -f : full status, populate the 'message' and 'size' fields Returns: @@ -446,16 +463,12 @@ Returns: 'stream_name': (str) stream name , 'suggested_file_name': (str) suggested file name, 'sd_hash': (str) sd hash of file, - 'name': (str) name claim attached to file - 'outpoint': (str) claim outpoint attached to file - 'claim_id': (str) claim ID attached to file, 'download_path': (str) download path of file, 'mime_type': (str) mime type of file, 'key': (str) key attached to file, 'total_bytes': (int) file size in bytes, None if full_status is false 'written_bytes': (int) written size in bytes 'message': (str), None if full_status is false - 'metadata': (dict) Metadata dictionary }, ] ``` @@ -467,8 +480,7 @@ Reflect all the blobs in a file matching the filter criteria Usage: file_reflect [--sd_hash=] [--file_name=] - [--stream_hash=] [--claim_id=] - [--outpoint=] [--rowid=] [--name=] + [--stream_hash=] [--rowid=] [--reflector=] Options: @@ -476,10 +488,7 @@ Options: --file_name= : get file with matching file name in the downloads folder --stream_hash= : get file with matching stream hash - --claim_id= : get file with matching claim id - --outpoint= : get file with matching claim outpoint --rowid= : get file with matching row id - --name= : get file with matching associated name claim --reflector= : reflector server, ip address or url by default choose a server from the config @@ -494,19 +503,14 @@ Start or stop downloading a file Usage: file_set_status [--sd_hash=] [--file_name=] - [--stream_hash=] [--claim_id=] - [--outpoint=] [--rowid=] - [--name=] + [--stream_hash=] [--rowid=] Options: --sd_hash= : set status of file with matching sd hash --file_name= : set status of file with matching file name in the downloads folder --stream_hash= : set status of file with matching stream hash - --claim_id= : set status of file with matching claim id - --outpoint= : set status of file with matching claim outpoint --rowid= : set status of file with matching row id - --name= : set status of file with matching associated name claim Returns: (str) Confirmation message @@ -626,8 +630,9 @@ Options: --metadata= : ClaimDict to associate with the claim. --file_path= : path to file to be associated with name. If provided, a lbry stream of this file will be used in 'sources'. - If no path is given but a metadata dict is provided, - the source from the given metadata will be used. + If no path is given but a sources dict is provided, + it will be used. If neither are provided, an + error is raised. --fee= : Dictionary representing key fee to download content: { 'currency': currency_symbol,