Skip to main content

ARLAS Command line for ARLAS Management

Project description

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.                                                           │
│                                           [default: None]                                                                          │
│ --print-curl     --no-print-curl          Print curl command [default: no-print-curl]                                              │
│ --version                                 Print command line version                                                               │
│ --help                                    Show this message and exit.                                                              │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ collections                                                                                                                        │
│ confs                                                                                                                              │
│ iam                                                                                                                                │
│ indices                                                                                                                            │
│ persist                                                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

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                                          │
│                       (/Users/gaudan/.arlas/cli/configuration.yaml).                                                               │
│                       [default: None]                                                                                              │
│ --help                Show this message and exit.                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ count           Count the number of hits within a collection (or all collection if not provided)                                   │
│ create          Create a collection                                                                                                │
│ delete          Delete a collection                                                                                                │
│ describe        Describe a collection                                                                                              │
│ list            List collections                                                                                                   │
│ name            Set the collection display name                                                                                    │
│ private         Set collection visibility to private                                                                               │
│ public          Set collection visibility to public                                                                                │
│ sample          Display a sample of a collection                                                                                   │
│ set_alias       Set the field display name                                                                                         │
│ share           Share the collection with the organisation                                                                         │
│ unshare         Unshare the collection with the organisation                                                                       │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

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                                          │
│                       (/Users/gaudan/.arlas/cli/configuration.yaml).                                                               │
│                       [default: None]                                                                                              │
│ --help                Show this message and exit.                                                                                  │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ clone          Clone an index and set its name                                                                                     │
│ create         Create an index                                                                                                     │
│ data           Index data                                                                                                          │
│ delete         Delete an index                                                                                                     │
│ describe       Describe an index                                                                                                   │
│ list           List indices                                                                                                        │
│ mapping        Generate the mapping based on the data                                                                              │
│ migrate        Migrate an index on another arlas configuration, and set the target index name                                      │
│ sample         Display a sample of 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 ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ create                     Add a configuration                                                                                     │
│ delete                     Delete a configuration                                                                                  │
│ describe                   Describe a configuration                                                                                │
│ list                       List configurations                                                                                     │
│ login                      Add a configuration for ARLAS Cloud                                                                     │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arlas_cli-26.2.0.tar.gz (18.6 kB view details)

Uploaded Source

Built Distribution

arlas_cli-26.2.0-py3-none-any.whl (22.4 kB view details)

Uploaded Python 3

File details

Details for the file arlas_cli-26.2.0.tar.gz.

File metadata

  • Download URL: arlas_cli-26.2.0.tar.gz
  • Upload date:
  • Size: 18.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for arlas_cli-26.2.0.tar.gz
Algorithm Hash digest
SHA256 41fcfa2f745f026c959deae89619c32473b392945b723e3701a3016536d6ecb4
MD5 1ed50c4c23595d7b2f4c71bdad97794b
BLAKE2b-256 0d22d203522bbe1c77696c9399f584e17160d75b6eed1b34e5a191d7feeca1ca

See more details on using hashes here.

File details

Details for the file arlas_cli-26.2.0-py3-none-any.whl.

File metadata

  • Download URL: arlas_cli-26.2.0-py3-none-any.whl
  • Upload date:
  • Size: 22.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for arlas_cli-26.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 d57b186a5b3bded4e0944199da9c01816281184c008aabfa77f7546cc4337d31
MD5 06d497c832a92f6a1e49e2ece59e724a
BLAKE2b-256 2557972a14b009b0348c675440c9ecf02a814283bf19fa0ee7d1358c04c06116

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page