Skip to main content

ARLAS Command line for collection management

python3 -m arlas.cli.cli  --help

 Usage: python -m arlas.cli.cli [OPTIONS] COMMAND [ARGS]...                   

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --config-file                       TEXT  Path to the configuration file   │
│                                           if you do not want to use the    │
│                                           default one:                     │
│                                           .arlas/cli/configuration.yaml.   │
│ --print-curl     --no-print-curl          Print curl command               │
│                                           [default: no-print-curl]         │
│ --version                                 Print command line version       │
│ --quiet          --no-quiet               Remove non-essential printing    │
│                                           [default: no-quiet]              │
│ --help                                    Show this message and exit.      │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ collections                                                                │
│ indices                                                                    │
│ persist                                                                    │
│ confs                                                                      │
│ iam                                                                        │
╰────────────────────────────────────────────────────────────────────────────╯

Actions on collections:

python3 -m arlas.cli.cli collections --help

 Usage: python -m arlas.cli.cli collections [OPTIONS] COMMAND [ARGS]...       

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --config        TEXT  Name of the ARLAS configuration to use from your     │
│                       configuration file                                   │
│                       (/home/gaudan/.arlas/cli/configuration.yaml).        │
│ --help                Show this message and exit.                          │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ list        List collections                                               │
│ count       Count the number of hits within a collection (or all           │
│             collection if not provided)                                    │
│ describe    Describe a collection                                          │
│ public      Set collection visibility to public                            │
│ private     Set collection visibility to private                           │
│ share       Share the collection with the organisation                     │
│ unshare     Unshare the collection with the organisation                   │
│ name        Set the collection display name                                │
│ set_alias   Set the field display name                                     │
│ sample      Display a sample of a collection                               │
│ delete      Delete a collection                                            │
│ create      Create a collection                                            │
╰────────────────────────────────────────────────────────────────────────────╯

Actions on indices:

python3 -m arlas.cli.cli indices --help

 Usage: python -m arlas.cli.cli indices [OPTIONS] COMMAND [ARGS]...           

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --config        TEXT  Name of the ARLAS configuration to use from your     │
│                       configuration file                                   │
│                       (/home/gaudan/.arlas/cli/configuration.yaml).        │
│ --help                Show this message and exit.                          │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ list       List indices                                                    │
│ describe   Describe an index                                               │
│ clone      Clone an index and set its name                                 │
│ migrate    Migrate an index on another arlas configuration, and set the    │
│            target index name                                               │
│ sample     Display a sample of an index                                    │
│ create     Create an index                                                 │
│ data       Index data                                                      │
│ mapping    Generate the mapping based on the data                          │
│ delete     Delete an index                                                 │
╰────────────────────────────────────────────────────────────────────────────╯

Actions on configurations:

python3 -m arlas.cli.cli confs --help

 Usage: python -m arlas.cli.cli confs [OPTIONS] COMMAND [ARGS]...             

╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ set        Set default configuration among existing configurations         │
│ default    Display the default configuration                               │
│ check      Check the services of a configuration                           │
│ list       List configurations                                             │
│ create     Add a configuration                                             │
│ login      Add a configuration for ARLAS Cloud                             │
│ delete     Delete a configuration                                          │
│ describe   Describe a configuration                                        │
╰────────────────────────────────────────────────────────────────────────────╯

Metadata

Release files for arlas-cli 26.6.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for arlas-cli 26.6.4
File Size Uploaded Provenance Actions
arlas_cli-26.6.4.tar.gz 26.5 kB Without provenance Details for arlas_cli-26.6.4.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for arlas-cli 26.6.4
File Interpreter ABI Platform Actions
arlas_cli-26.6.4-py3-none-any.whl Python 3 none any Details for arlas_cli-26.6.4-py3-none-any.whl

Total release size: 58.0 kB

Release files / arlas_cli-26.6.4.tar.gz

Download URL arlas_cli-26.6.4.tar.gz
Size 26.5 kB
Tags Source
SHA-256 checksum
How to use checksums
151de77da1c6896906c7d32a5bb805fbb120c27a61d766d17707adac97b9434c
BLAKE2b-256 checksum
How to use checksums
aa449b23359813462750e821bd60491119c32e5b05fb804881914d6f3c680fbc
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Release files / arlas_cli-26.6.4-py3-none-any.whl

Download URL arlas_cli-26.6.4-py3-none-any.whl
Size 31.5 kB
Tags Python 3
SHA-256 checksum
How to use checksums
c716d2dd4d4452dbc0361a4eb23ea7ec3857bc6487c2f2e9ae36df3ab15ff542
BLAKE2b-256 checksum
How to use checksums
842000c9d1957a9dc496da72dcbe670c1f43a2a86d40946ae54aed28bad5b905
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.13.7

Security for arlas-cli 26.6.4

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

26.6.4 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page