github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/docs/cli/help.md (about) 1 --- 2 layout: post 3 title: HELP 4 permalink: /docs/cli/help 5 redirect_from: 6 - /cli/help.md/ 7 - /docs/cli/help.md/ 8 --- 9 10 This readme is a loose assortment of quick tips. 11 12 ## Installing CLI directly from the latest GitHub release 13 14 The default destination is /usr/local/bin but here we install into /tmp/www 15 16 ```console 17 $ scripts/install_from_binaries.sh --dstdir /tmp/www 18 Installing aisloader => /tmp/www/aisloader 19 % Total % Received % Xferd Average Speed Time Time Time Current 20 Dload Upload Total Spent Left Speed 21 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 22 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 23 100 9847k 100 9847k 0 0 3553k 0 0:00:02 0:00:02 --:--:-- 4301k 24 aisloader 25 Installing CLI => /tmp/www/ais 26 % Total % Received % Xferd Average Speed Time Time Time Current 27 Dload Upload Total Spent Left Speed 28 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 29 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0 30 100 9.9M 100 9.9M 0 0 4436k 0 0:00:02 0:00:02 --:--:-- 5901k 31 ais 32 Downloading CLI autocompletions (bash & zsh)... 33 % Total % Received % Xferd Average Speed Time Time Time Current 34 Dload Upload Total Spent Left Speed 35 100 2350 100 2350 0 0 7000 0 --:--:-- --:--:-- --:--:-- 6994 36 % Total % Received % Xferd Average Speed Time Time Time Current 37 Dload Upload Total Spent Left Speed 38 100 578 100 578 0 0 1673 0 --:--:-- --:--:-- --:--:-- 1675 39 NOTE: 40 *** CLI autocompletions are now copied to /etc/bash_completion.d/ais *** 41 *** To enable, simply run: source /etc/bash_completion.d/ais *** 42 43 Done. 44 45 $ ls /tmp/www 46 ais aisloader 47 ``` 48 49 To see the version: 50 ```console 51 $ ais version 52 version 1.1.950525a50 (build 2023-03-30T18:51:58-0400) 53 ``` 54 55 # Getting help 56 57 Note that `ais help <command>` is identical to `ais <command> --help`. In fact, the `--help` option is absolutely universal and will work across the entire CLI terms of providing context-relevant information. 58 59 But first, let's see all CLI top-level commands with brief descriptions. 60 61 > The text below can serve as a 30-seconds brief introduction into CLI usage and its capabilities. 62 63 ```console 64 NAME: 65 ais - AIS CLI: command-line management utility for AIStore 66 67 USAGE: 68 ais [global options] command [command options] [arguments...] 69 70 VERSION: 71 1.1.950525a50 72 73 DESCRIPTION: 74 If <TAB-TAB> completion doesn't work: 75 * download https://github.com/NVIDIA/aistore/tree/main/cmd/cli/autocomplete 76 * run 'cmd/cli/autocomplete/install.sh' 77 To install CLI directly from GitHub: https://github.com/NVIDIA/aistore/blob/main/scripts/install_from_binaries.sh 78 79 COMMANDS: 80 bucket create/destroy buckets, list bucket's contents, show existing buckets and their properties 81 object put, get, list, rename, remove, and other operations on objects 82 cluster monitor and manage AIS cluster: add/remove nodes, change primary gateway, etc. 83 config configure AIS cluster and individual nodes (in the cluster); configure CLI (tool) 84 etl execute custom transformations on objects 85 job monitor, query, start/stop and manage jobs and eXtended actions (xactions) 86 auth add/remove/show users, manage user roles, manage access to AIS clusters 87 show show configuration, buckets, jobs, etc. - all managed entities in the cluster, and the cluster itself 88 help show a list of commands; show help for a given command 89 advanced special commands intended for development and advanced usage 90 storage monitor and manage clustered storage 91 archive Create multi-object archive, append files to an existing archive 92 log show log 93 performance show performance counters, throughput, latency, and more (press <TAB-TAB> to select specific view) 94 remote-cluster show attached AIS clusters 95 alias manage top-level aliases 96 put (alias for "object put") PUT or APPEND one file or one directory, or multiple files and/or directories. 97 - use optional shell filename pattern (wildcard) to match/select sources; 98 - request '--compute-checksum' to facilitate end-to-end protection; 99 - progress bar via '--progress' to show runtime execution (uploaded files count and size); 100 - when writing directly from standard input use Ctrl-D to terminate; 101 - use '--archpath' to APPEND to an existing tar-formatted object. 102 start (alias for "job start") run batch job 103 stop (alias for "job stop") terminate a single batch job or multiple jobs (press <TAB-TAB> to select, '--help' for options) 104 wait (alias for "job wait") wait for a specific batch job to complete (press <TAB-TAB> to select, '--help' for options) 105 cp (alias for "bucket cp") copy entire bucket or selected objects (to select, use '--list' or '--template') 106 create (alias for "bucket create") create ais buckets 107 get (alias for "object get") get an object, an archived file, or a range of bytes from the above, and in addition: 108 - write the content locally with destination options including: filename, directory, STDOUT ('-'); 109 - use '--prefix' to get multiple objects in one shot (empty prefix for the entire bucket). 110 ls (alias for "bucket ls") list buckets, objects in buckets, and files in objects formatted as archives 111 search search ais commands 112 113 GLOBAL OPTIONS: 114 --help, -h show help 115 --version, -v print the version 116 ``` 117 118