Metadata-Version: 2.1
Name: arlas-cli
Version: 0.1.8
Summary: ARLAS Command line for collection management
Home-page: UNKNOWN
Author: Gisaïa
License: UNKNOWN
Description: # ARLAS Command line for collection management
        
        ```
        python3 -m arlas.cli.cli  --help
                                                                                                                                                                       
         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 ───────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
        │ --install-completion          Install completion for the current shell.                                                                                     │
        │ --show-completion             Show completion for the current shell, to copy it or customize the installation.                                              │
        │ --help                        Show this message and exit.                                                                                                   │
        ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
        ╭─ Commands ──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╮
        │ collections                                                                                                                                                 │
        │ indices                                                                                                                                                     │
        ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
        
        ```
        
        Actions on collections:
        
        ```
        python3 -m arlas.cli.cli demo collections  --help
                                                                                                                                                                       
         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                                                                                                                        │
        │ delete           Delete 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
                                                                                                                                                                       
         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                                                                                                                 │
        │ mapping                        Generate the mapping based on the data                                                                                       │
        │ sample                         Display a sample of an index                                                                                                 │
        ╰─────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
        
        ```
        
Platform: UNKNOWN
Requires-Python: >=3.11
Description-Content-Type: text/markdown
