Metadata-Version: 2.1
Name: arlas-cli
Version: 0.0.24
Summary: ARLAS Command line for collection management
Home-page: UNKNOWN
Author: Gisaïa
License: UNKNOWN
Platform: UNKNOWN
Requires-Python: >=3.11
Description-Content-Type: text/markdown
Requires-Dist: click (==8.1.7)
Requires-Dist: typer (==0.9.0)
Requires-Dist: python-dateutil (==2.8.2)
Requires-Dist: envyaml (==1.10.211231)
Requires-Dist: PyJWT (==2.8.0)
Requires-Dist: attrs (==23.2.0)
Requires-Dist: python-dotenv (==1.0.0)
Requires-Dist: requests (==2.31.0)
Requires-Dist: prettytable (==3.9.0)
Requires-Dist: pydantic (==2.5.3)

# ARLAS Command line for collection management

```
python3 -m arlas.cli.cli  --help
arlas_cli 0.0.24

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

╭─ Arguments ────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ *    arlas_configuration      TEXT  Name of the ARLAS configuration to use from your configuration file (/Users/gaudan/.arlas/cli/configuration.yaml). [default: None] [required]                                      │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ collections                                                                                                                                                                                                            │
│ indices                                                                                                                                                                                                                │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```

Actions on collections:

```
python3 -m arlas.cli.cli demo collections  --help
arlas_cli 0.0.24

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

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --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                                                                                                                                                                             │
│ describe               Describe a collection                                                                                                                                                                           │
│ list                   List collections                                                                                                                                                                                │
│ sample                 Display a sample of a collection                                                                                                                                                                │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```

Actions on indices:

```
python3 -m arlas.cli.cli demo indices  --help
arlas_cli 0.0.24

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

╭─ Options ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ --help          Show this message and exit.                                                                                                                                                                            │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ create                                              Create an index                                                                                                                                                    │
│ data                                                Index data                                                                                                                                                         │
│ delete                                              Delete an index                                                                                                                                                    │
│ describe                                            Describe an index                                                                                                                                                  │
│ list                                                List indices                                                                                                                                                       │
│ sample                                              Display a sample of an index                                                                                                                                       │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯

```


