ATLAS CLI (atlas)#

file version: 10 Jul 2026

The ATLAS command-line client, atlas, is the terminal interface for the Versity ATLAS service. It can be used interactively or from scripts to manage sessions, transfer files, stage data from tape, and inspect metadata and tags.

Quick Start#

The general command pattern is:

atlas [flags]
atlas [command]

Common Session Commands#

Command	Description
`id`	Show current user identity
`login`	Authenticate with the ATLAS server
`logout`	End the current session
`status`	Show server and session status

File Operations#

Command	Description
`acl`	Manage POSIX access control lists
`cd`	Change working directory
`checksum`	Get, set, generate, verify, or clear file checksums
`chmod`	Change file permissions
`chown`	Change file ownership
`cp`	Copy files or directories
`download`	Download file(s) from the server
`ls`	List directory contents
`mkdir`	Create a directory
`mv`	Move or rename files (inside HSM), do not use between different filesystems
`pwd`	Print working directory
`retention`	Get, set, or clear file retention period
`rm`	Remove files or directories
`upload`	Upload file(s) to the server

Metadata and Search#

Command	Description
`metadata`	Show metadata for a file
`search`	Search for files by metadata
`tag`	List, add, set, modify, or remove tags on a file

Archive Handling#

Command	Description
`release`	Release file data, making it offline
`stage`	Stage files from archive and bring them online

Jobs and Resources#

Command	Description
`jobs`	Manage asynchronous jobs
`resources`	Manage storage resources
`access`	Manage access control for administrators

Utility Commands#

Command	Description
`shell`	Enter the interactive shell
`version`	Show the `atlas` version

Additional Commands#

Command	Description
`completion`	Generate shell completion scripts
`help`	Show help for any command
`sessions`	View and manage active sessions

Global Flags#

Flag	Description
`--ca-cert string`	Path to the CA certificate for server verification
`-f, --format string`	Output format (`table`, `json`, `csv`); default is `table`
`-h, --help`	Show help for `atlas`
`-L, --lang string`	Interface language (`en`, `de`)
`--no-color`	Disable color output
`-P, --plaintext`	Use a plaintext, non-TLS connection
`-s, --server string`	ATLAS server address; defaults to `ACLI_SERVER`, then the stored session, `/etc/atlas/atlas.conf`, and finally `localhost:7449`
`--tls-skip-verify`	Skip TLS certificate verification; enabled by default for self-signed setups

See atlas [command] --help for command-specific details.