For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Blog
DocsAPI Reference
DocsAPI Reference
    • AIStore
    • Documentation
  • Core Documentation
    • In-depth Overview
    • Terminology and core abstractions
    • Getting Started
    • Networking model
    • Buckets: design, operations, namespaces, and system buckets
    • Observability overview
    • CLI overview
    • Production deployment
    • Technical Blog
  • APIs, SDKs, and Compatibility
    • Go API
    • Python SDK
    • PyPI package
    • Python SDK reference guide
    • PyTorch integration
    • TensorFlow integration
    • HTTP API reference
    • curl examples
    • Easy URL
    • S3 compatibility
    • s3cmd quick start
    • Presigned S3 requests
    • Boto3 support
  • Command-Line Interface
    • CLI overview
    • ais help
    • CLI reference guide
    • Bucket operations
    • Cluster and remote-cluster management
    • Storage and mountpath management
    • Monitoring and ais show
    • Downloads
    • Jobs
    • Authentication and access control
    • Configuration via CLI
    • ETL CLI
    • Distributed shuffle CLI
    • ML / get-batch CLI
    • GCP credentials
    • TLS certificate management
  • Storage and Data Management
    • Storage services
    • Buckets: design, operations, namespaces, and system buckets
    • Native Bucket Inventory (NBI)
    • Backend providers
    • On-disk layout
    • Virtual directories
    • System files
    • Evicting remote buckets and cached data
  • Cluster Operations
    • Node lifecycle: maintenance, shutdown, decommission
    • Global rebalance
    • Resilver
    • AIS in Containerized Environments
    • Highly available control plane
    • Information Center (IC)
    • Out-of-band updates
    • Troubleshooting
  • Configuration and Security
    • Configuration
    • Environment variables
    • Feature flags
    • AuthN and access control
    • Authentication validation
    • HTTPS and certificates
    • Switching a cluster to HTTPS
  • ETL and Advanced Workflows
    • ETL overview
    • ETL CLI docs
    • ETL Python SDK examples
    • Custom transformers
    • ETL Python webserver SDK
    • ETL Go webserver package
    • Archives: read, write, and list
    • Distributed shuffle (dsort)
    • Initial sharding utility (ishard)
    • Downloader
    • Blob Downloader
    • Batch object retrieval (get-batch)
    • Batch operations
    • Tools and utilities
    • Extended actions (xactions)
  • Observability, Monitoring, and Performance
    • Observability overview
    • Monitoring with CLI
    • Logs
    • Prometheus integration
    • Metrics reference
    • Grafana dashboards
    • Kubernetes monitoring
    • Distributed tracing
    • Monitoring get-batch
    • AIS load generator (aisloader)
    • Benchmarking AIStore
    • Performance tuning and testing
    • Performance monitoring via CLI
    • Rate limiting
    • Checksumming
    • Filesystem Health Checker (FSHC)
    • Traffic patterns
  • Networking
    • Networking: multi-homing, network separation, IPv6
    • HTTPS configuration
    • Switching to HTTPS
    • Idle connections
    • MessagePack protocol
  • Deployment
    • AIStore on Kubernetes
    • Kubernetes Operator
    • Ansible playbooks
    • Helm charts
    • Deployment monitoring
    • Docker
  • Developer Resources
    • Development guide
    • aisnode command line
    • Build tags
  • Object and Bucket Naming
    • Unicode and special symbols in object and bucket names
    • Extremely long object names
Blog
NVIDIANVIDIA
Developer-friendly docs for your API
Privacy Policy | Your Privacy Choices | Terms of Service | Accessibility | Corporate Policies | Product Security | Contact

Copyright © 2026, NVIDIA Corporation.

LogoLogoAIStore
On this page
  • Installing CLI directly from the latest GitHub release
  • Getting help
Command-Line Interface

ais help

||View as Markdown|
Previous

S3 compatibility

Next

Bucket operations

This readme is a loose assortment of quick tips.

Installing CLI directly from the latest GitHub release

The default destination is /usr/local/bin but here we install into /tmp/www

1$ scripts/install_from_binaries.sh --dstdir /tmp/www
2Installing aisloader => /tmp/www/aisloader
3 % Total % Received % Xferd Average Speed Time Time Time Current
4 Dload Upload Total Spent Left Speed
5 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
6 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
7100 9847k 100 9847k 0 0 3553k 0 0:00:02 0:00:02 --:--:-- 4301k
8aisloader
9Installing CLI => /tmp/www/ais
10 % Total % Received % Xferd Average Speed Time Time Time Current
11 Dload Upload Total Spent Left Speed
12 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
13 0 0 0 0 0 0 0 0 --:--:-- --:--:-- --:--:-- 0
14100 9.9M 100 9.9M 0 0 4436k 0 0:00:02 0:00:02 --:--:-- 5901k
15ais
16Downloading CLI autocompletions (bash & zsh)...
17 % Total % Received % Xferd Average Speed Time Time Time Current
18 Dload Upload Total Spent Left Speed
19100 2350 100 2350 0 0 7000 0 --:--:-- --:--:-- --:--:-- 6994
20 % Total % Received % Xferd Average Speed Time Time Time Current
21 Dload Upload Total Spent Left Speed
22100 578 100 578 0 0 1673 0 --:--:-- --:--:-- --:--:-- 1675
23NOTE:
24 *** CLI autocompletions are now copied to /etc/bash_completion.d/ais ***
25 *** To enable, simply run: source /etc/bash_completion.d/ais ***
26
27Done.
28
29$ ls /tmp/www
30ais aisloader

To see the version:

1$ ais version
2version 1.1.950525a50 (build 2023-03-30T18:51:58-0400)

Getting help

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.

But first, let’s see all CLI top-level commands with brief descriptions.

The text below can serve as a 30-seconds brief introduction into CLI usage and its capabilities.

1NAME:
2 ais - AIS CLI: command-line management utility for AIStore
3
4USAGE:
5 ais [global options] [arguments...] command [command options]
6
7VERSION:
8 1.18.605c658ff
9
10TAB completions (Bash and Zsh):
11 If <TAB-TAB> completion doesn't work:
12 * download https://github.com/NVIDIA/aistore/tree/main/cmd/cli/autocomplete
13 * run 'cmd/cli/autocomplete/install.sh'
14 To install CLI directly from GitHub: https://github.com/NVIDIA/aistore/blob/main/scripts/install_from_binaries.sh
15
16COMMANDS:
17 bucket Create and destroy buckets, list bucket's content, show existing buckets and their properties
18 object PUT, GET, list, rename, remove, and other operations on objects
19 cluster Monitor and manage AIS cluster: add/remove nodes, change primary gateway, etc.
20 config Configure AIS cluster and individual nodes (in the cluster); configure CLI (tool)
21 etl Manage and execute custom ETL (Extract, Transform, Load) jobs
22 job Monitor, query, start/stop and manage jobs and eXtended actions (xactions)
23 auth Add/remove/show users, manage user roles, manage access to AIS clusters
24 show Show configuration, buckets, jobs, etc. - all managed entities in the cluster, and the cluster itself
25 help Show a list of commands; show help for a given command
26 advanced Special commands intended for development and advanced usage
27 storage Monitor and manage clustered storage
28 archive Archive multiple objects from a given bucket; archive local files and directories; list archived content
29 log View ais node's log in real time; download the current log; download all logs (history)
30 tls Load or reload (an updated) TLS certificate; display information about currently deployed certificates
31 performance Show performance counters, throughput, latency, disks, used/available capacities (press <TAB-TAB> to select specific view)
32 remote-cluster Show attached AIS clusters
33 ml Machine learning operations: batch dataset operations, and ML-specific workflows
34 alias Manage top-level aliases
35 kubectl Show Kubernetes pods and services
36
37GLOBAL OPTIONS:
38 --help, -h Show help
39 --version, -v print the version
40
41ALIASES:
42 cp => 'bucket cp'; create => 'bucket create'; evict => 'bucket evict';
43 ls => 'bucket ls'; rmb => 'bucket rm'; start => 'job start';
44 blob-download => 'job start blob-download'; download => 'job start download';
45 dsort => 'job start dsort'; stop => 'job stop'; wait => 'job wait';
46 get => 'object get'; prefetch => 'object prefetch'; put => 'object put';
47 rmo => 'object rm'; space-cleanup => 'storage cleanup'; scrub => 'storage validate'