github.com/NVIDIA/aistore@v1.3.23-0.20240517131212-7df6609be51d/docs/tools.md (about)

     1  ---
     2  layout: post
     3  title: TOOLS
     4  permalink: /docs/tools
     5  redirect_from:
     6   - /tools.md/
     7   - /docs/tools.md/
     8  ---
     9  
    10  ## Table of Contents
    11  - [Executables](#executables)
    12  - [Installing from GitHub](#installing-from-github)
    13  - [Installing from source](#installing-from-source)
    14  
    15  ## Executables
    16  
    17  | Directory | Binary name | Description  | README |
    18  |---|---|---|---|
    19  | `cmd/cli` | `ais` | AIS command line management utility | [CLI](/docs/cli.md) |
    20  | `cmd/aisloader` and `bench/tools/aisloader` | `aisloader` | AIS Load generator, a powerful benchmark utility | [aisloader](/docs/aisloader.md) |
    21  | `bench/tools/aisloader-composer` | `aisloader-composer` | Scripts and ansible playbooks to benchmark an AIS cluster using multiple hosts running [aisloader](/bench/tools/aisloader), controlled by [ansible](https://github.com/ansible/ansible)  | [aisloader-composer](/bench/tools/aisloader-composer)    |
    22  | `cmd/aisnode` | `aisnode` | AIS node (gateway or target) binary | |
    23  | `cmd/aisnodeprofile` | `aisnode` | ... with profiling enabled | |
    24  | `cmd/authn` | `authn` | Standalone server providing token-based secure access to AIS clusters | [AuthN](/docs/authn.md) |
    25  | `cmd/xmeta` | `xmeta` | Low-level tool to format (or extract in plain text) assorted AIS metadata and control structures | [xmeta](/cmd/xmeta/README.md) |
    26  
    27  **NOTE**: installed CLI executable is named `ais`.
    28  
    29  ## Installing from GitHub
    30  
    31  Generally, AIStore (cluster) requires at least some sort of [deployment](/deploy#contents) process or sequence. 
    32  
    33  Standalone binaries, on the other hand, can be [built](Makefile) from source or installed directly from the latest or previous GitHub releases.
    34  
    35  **NOTE:** binary installation is supported only for the `linux-amd64` platform.
    36  
    37  In particular:
    38  
    39  ```console
    40  $ ./scripts/install_from_binaries.sh --help
    41  
    42  NAME:
    43    install_from_binaries.sh - install 'ais' (CLI) and 'aisloader' from release binaries
    44  
    45  USAGE:
    46    ./install_from_binaries.sh [options...]
    47  
    48  OPTIONS:
    49    --tmpdir <dir>        work directory, e.g. /root/tmp
    50    --dstdir <dir>        installation destination
    51    --release             e.g., v1.3.15, v1.3.16, latest (default: latest)
    52    --completions         install and enable _only_ CLI autocompletions (ie., skip installing binaries)
    53  ```
    54  
    55  **NOTE:** For CLI, the script will also enable auto-completions. CLI can be used without (bash, zsh) auto-completions but, generally, using using auto-completions is strongly recommended.
    56  
    57  ### Example: download 'ais' and 'aisloader' binaries from the latest release
    58  
    59  ```console
    60  $ ./install_from_binaries.sh --dstdir /tmp/qqq
    61  ```
    62  
    63  Upon execution, the two specific `linux-amd64` binaries, ready for usage, will be placed in `/tmp/qqq` destination.
    64  
    65  ## Installing from source
    66  
    67  ### CLI
    68  
    69  The preferable way is to use [Makefile](/Makefile):
    70  
    71  ```console
    72  $ make cli
    73  ```
    74  
    75  builds AIS CLI from the local aistore repository and installs it in your $GOPATH/bin.
    76  
    77  **NOTE**: installed CLI binary is named `ais`.
    78  
    79  Alternatively, you could also use `go install`:
    80  
    81  ```console
    82  $ go install github.com/NVIDIA/aistore/cmd/cli@latest` && mv $GOPATH/bin/cli $GOPATH/bin/ais
    83  ```
    84  
    85  To install CLI auto-completions, you could also, and separately, use `cmd/cli/install_autocompletions.sh`
    86  
    87  ### aisloader
    88  
    89  [Makefile](/Makefile) way:
    90  
    91  ```console
    92  $ make aisloader
    93  ```
    94  
    95  But again, you could also use `go install`:
    96  
    97  ```console
    98  $ go install github.com/NVIDIA/aistore/cmd/aisloader@latest
    99  ```
   100  
   101  ## xmeta
   102  
   103  `xmeta` is a low-level utility to format (or extract and show) assorted AIS control structures - see [usage](/cmd/xmeta/README.md).
   104  
   105  For command line options and usage examples, simply run `xmeta` with no arguments:
   106  
   107  ```console
   108  $ xmeta
   109  Usage of xmeta:
   110    -f string ...
   111  ...
   112  Examples:
   113          # Smap:
   114          xmeta -x -in=~/.ais0/.ais.smap      - extract Smap to STDOUT
   115  ...
   116  ```
   117  
   118  To install, run:
   119  
   120  ```console
   121  $ make xmeta
   122  ```
   123  
   124  OR, same:
   125  
   126  ```console
   127  $ cd cmd/xmeta
   128  $ go install
   129  ```