diff --git a/README.md b/README.md index 366855b..af1cb40 100644 --- a/README.md +++ b/README.md @@ -6,4 +6,16 @@ See the documentation at https://gisaia.github.io/arlas_cli/ ## Developer section -To run the commands locally from the project root, simply replace `arlas_cli` by `python3.10 -m arlas.cli.cli` \ No newline at end of file +### Run arlas_cli commands locally + +To run the commands locally from the project root, simply replace `arlas_cli` by `python3.10 -m arlas.cli.cli` + +### Release + +To release `arlas_cli`, make sure to be at project root on the branch `master` up to date. + +Run in the terminal: + +``` +./scripts/release.sh {ARLAS_CLI_VERSION} +``` \ No newline at end of file diff --git a/docs/docs/collections.md b/docs/docs/collections.md index 061c303..b806c0a 100644 --- a/docs/docs/collections.md +++ b/docs/docs/collections.md @@ -9,32 +9,27 @@ ARLAS collections are built on top of [elasticsearch (ES) index](concepts.md#es- ```shell > arlas_cli collections --help - - Usage: arlas_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 │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections [OPTIONS] COMMAND [ARGS]... +Options: + --config TEXT Name of the ARLAS configuration to use from your + configuration file + (/home/willi/.arlas/cli/configuration.yaml). + --help Show this message and exit. + +Commands: + count Count the number of hits within a collection (or all... + 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 ``` ## create @@ -46,45 +41,29 @@ The command line options let you specify how the index should be used by the col ```shell > arlas_cli collections --config local create --help - - Usage: arlas_cli collections create [OPTIONS] COLLECTION - - Create a collection - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --model TEXT Name of the model within your │ -│ configuration, or URL or file path │ -│ [default: None] │ -│ --index TEXT Name of the index referenced by │ -│ the collection │ -│ [default: None] │ -│ --display-name TEXT Display name of the collection │ -│ [default: None] │ -│ --public --no-public Whether the collection is public │ -│ or not │ -│ [default: no-public] │ -│ --owner TEXT Organisation's owner │ -│ [default: None] │ -│ --orgs TEXT List of organisations accessing │ -│ the collection │ -│ --id-path TEXT Override the JSON path to the id │ -│ field. │ -│ [default: None] │ -│ --centroid-path TEXT Override the JSON path to the │ -│ centroid field. │ -│ [default: None] │ -│ --geometry-path TEXT Override the JSON path to the │ -│ geometry field. │ -│ [default: None] │ -│ --date-path TEXT Override the JSON path to the date │ -│ field. │ -│ [default: None] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections create [OPTIONS] COLLECTION + + Create a collection +Arguments: + COLLECTION Collection's name [required] + +Options: + --model TEXT Name of the model within your configuration, or URL + or file path + --index TEXT Name of the index referenced by the collection + --display-name TEXT Display name of the collection + --public / --no-public Whether the collection is public or not [default: + no-public] + --owner TEXT Organisation's owner + --orgs TEXT List of organisations accessing the collection + --id-path TEXT Override the JSON path to the id field. + --centroid-path TEXT Override the JSON path to the centroid field. + --geometry-path TEXT Override the JSON path to the geometry field. + --date-path TEXT Override the JSON path to the date field. + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` !!! note "Collection visibility" @@ -160,19 +139,18 @@ The collection can be defined by a pretty name. It can be set with `name` subcom ```shell > arlas_cli collections --config local name --help - - Usage: arlas_cli collections name [OPTIONS] COLLECTION NAME - - Set the collection display name - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -│ * name TEXT The display name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections name [OPTIONS] COLLECTION NAME + + Set the collection display name + +Arguments: + COLLECTION Collection's name [required] + NAME The display name [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Set a pretty name for the collection @@ -193,26 +171,21 @@ The data fields are sometimes not very suitable in ARLAS Exploration dashboards. ```shell > arlas_cli collections --config local set_alias --help - - Usage: arlas_cli collections set_alias [OPTIONS] COLLECTION FIELD_PATH - [DISPLAY_NAME] - - Set the field display name - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] │ -│ [required] │ -│ * field_path TEXT The field path [default: None] │ -│ [required] │ -│ display_name [DISPLAY_NAME] The field's display name. If none │ -│ provided, then the alias is removed │ -│ if it existed │ -│ [default: None] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections set_alias [OPTIONS] COLLECTION FIELD_PATH + [DISPLAY_NAME] + + Set the field display name + +Arguments: + COLLECTION Collection's name [required] + FIELD_PATH The field path [required] + [DISPLAY_NAME] The field's display name. If none provided, then the alias + is removed if it existed + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Set a pretty name for a data field @@ -253,18 +226,17 @@ The `describe` command line provides a description of the collection's structure ```shell > arlas_cli collections --config local describe --help - - Usage: arlas_cli collections describe [OPTIONS] COLLECTION - - Describe a collection - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections describe [OPTIONS] COLLECTION + Describe a collection + +Arguments: + COLLECTION Collection's name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## count @@ -276,19 +248,18 @@ The `count` command show the total number of elements (data rows) accessible in ```shell > arlas_cli collections --config local count --help - - Usage: arlas_cli collections count [OPTIONS] [COLLECTION] - - Count the number of hits within a collection (or all collection if not - provided) - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ collection [COLLECTION] Collection's name [default: None] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections count [OPTIONS] [COLLECTION] + + Count the number of hits within a collection (or all collection if not + provided) + +Arguments: + [COLLECTION] Collection's name +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## sample @@ -300,20 +271,19 @@ The `sample` command show few data rows accessible in a collection. ```shell > arlas_cli collections --config local sample --help - - Usage: arlas_cli collections sample [OPTIONS] COLLECTION - - Display a sample of a collection - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --pretty --no-pretty [default: pretty] │ -│ --size INTEGER [default: 10] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections sample [OPTIONS] COLLECTION + Display a sample of a collection + +Arguments: + COLLECTION Collection's name [required] + +Options: + --pretty / --no-pretty [default: pretty] + --size INTEGER [default: 10] + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` !!! note @@ -332,18 +302,17 @@ To switch a collection from **public** to **private**, use the `private` command ```shell > arlas_cli collections --config local private --help - - Usage: arlas_cli collections private [OPTIONS] COLLECTION - - Set collection visibility to private - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections private [OPTIONS] COLLECTION + + Set collection visibility to private +Arguments: + COLLECTION Collection's name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## public @@ -357,18 +326,17 @@ To switch a collection from **private** to **public**, use the `public` command: ```shell > arlas_cli collections --config local public --help - - Usage: arlas_cli collections public [OPTIONS] COLLECTION - - Set collection visibility to public - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections public [OPTIONS] COLLECTION + + Set collection visibility to public +Arguments: + COLLECTION Collection's name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## share @@ -382,20 +350,18 @@ A collection can be shared to other organisation with the `share` command: ```shell > arlas_cli collections --config local share --help - - Usage: arlas_cli collections share [OPTIONS] COLLECTION ORGANISATION - - Share the collection with the organisation - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -│ * organisation TEXT Organisation's name [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections share [OPTIONS] COLLECTION ORGANISATION + + Share the collection with the organisation + +Arguments: + COLLECTION Collection's name [required] + ORGANISATION Organisation's name [required] +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## unshare @@ -409,20 +375,18 @@ The access to a collection can be removed with the `unshare` command: ```shell > arlas_cli collections --config local unshare --help - - Usage: arlas_cli collections unshare [OPTIONS] COLLECTION ORGANISATION - - Unshare the collection with the organisation - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT Collection's name [default: None] [required] │ -│ * organisation TEXT Organisation's name [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections unshare [OPTIONS] COLLECTION ORGANISATION + + Unshare the collection with the organisation +Arguments: + COLLECTION Collection's name [required] + ORGANISATION Organisation's name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ## delete @@ -436,16 +400,15 @@ The collection can be removed with the `delete` command: ```shell > arlas_cli collections --config local delete --help - - Usage: arlas_cli collections delete [OPTIONS] COLLECTION - - Delete a collection - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * collection TEXT collection's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli collections delete [OPTIONS] COLLECTION + + Delete a collection + +Arguments: + COLLECTION collection's name [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` \ No newline at end of file diff --git a/docs/docs/confs.md b/docs/docs/confs.md index 6a2dc12..43adbc4 100644 --- a/docs/docs/confs.md +++ b/docs/docs/confs.md @@ -14,20 +14,17 @@ It is possible, with the `arlas_cli confs` command lines, to manage the ARLAS co ```shell > arlas_cli confs --help - - Usage: arlas_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 │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_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 ``` @@ -38,63 +35,39 @@ It is possible, with the `arlas_cli confs` command lines, to manage the ARLAS co ```shell > arlas_cli confs create --help - - Usage: arlas_cli confs create [OPTIONS] NAME - - Add a configuration - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * name TEXT Name of the configuration [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ * --server TEXT ARLAS Server url │ -│ [default: None] │ -│ [required] │ -│ --headers TEXT header (name:value) │ -│ --persistence TEXT ARLAS Persistence │ -│ url │ -│ [default: None] │ -│ --persistence-head… TEXT header (name:value) │ -│ --elastic TEXT elasticsearch url │ -│ [default: None] │ -│ --elastic-login TEXT elasticsearch login │ -│ [default: None] │ -│ --elastic-password TEXT elasticsearch │ -│ password │ -│ [default: None] │ -│ --elastic-headers TEXT header (name:value) │ -│ --allow-delete --no-allow-delete Is delete command │ -│ allowed for this │ -│ configuration? │ -│ [default: │ -│ no-allow-delete] │ -│ --auth-token-url TEXT Token URL of the │ -│ authentication │ -│ service │ -│ [default: None] │ -│ --auth-headers TEXT header (name:value) │ -│ --auth-org TEXT ARLAS IAM │ -│ Organization │ -│ [default: None] │ -│ --auth-login TEXT login │ -│ [default: None] │ -│ --auth-password TEXT password │ -│ [default: None] │ -│ --auth-client-id TEXT Client ID │ -│ [default: None] │ -│ --auth-client-secr… TEXT Client secret │ -│ [default: None] │ -│ --auth-grant-type TEXT Grant type (e.g. │ -│ password) │ -│ [default: None] │ -│ --auth-arlas-iam --no-auth-arlas-iam Is it an ARLAS IAM │ -│ service? │ -│ [default: │ -│ auth-arlas-iam] │ -│ --help Show this message │ -│ and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ - +Usage: arlas_cli confs create [OPTIONS] NAME + + Add a configuration + +Arguments: + NAME Name of the configuration [required] + +Options: + --server TEXT ARLAS Server url [required] + --headers TEXT header (name:value) + --persistence TEXT ARLAS Persistence url + --persistence-headers TEXT header (name:value) + --elastic TEXT elasticsearch url + --elastic-login TEXT elasticsearch login + --elastic-password TEXT elasticsearch password + --elastic-headers TEXT header (name:value) + --allow-delete / --no-allow-delete + Is delete command allowed for this + configuration? [default: no-allow-delete] + --auth-token-url TEXT Token URL of the authentication service + --auth-headers TEXT header (name:value) + --auth-org TEXT ARLAS IAM Organization + --auth-login TEXT login + --auth-password TEXT password + --auth-client-id TEXT Client ID + --auth-client-secret TEXT Client secret + --auth-grant-type TEXT Grant type (e.g. password) + --auth-arlas-iam / --no-auth-arlas-iam + Is it an ARLAS IAM service? [default: auth- + arlas-iam] + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` @@ -176,33 +149,26 @@ The `confs longin` allows to create a configuration linked to an ARLAS Cloud acc ```shell > arlas_cli confs login --help - - Usage: arlas_cli confs login [OPTIONS] AUTH_LOGIN ELASTIC_LOGIN ELASTIC - - Add a configuration for ARLAS Cloud - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * auth_login TEXT ARLAS login [default: None] [required] │ -│ * elastic_login TEXT Elasticsearch login [default: None] │ -│ [required] │ -│ * elastic TEXT Elasticsearch url [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --auth-org TEXT ARLAS IAM Organization, │ -│ default is your email │ -│ domain name │ -│ [default: None] │ -│ --allow-delete --no-allow-delete Is delete command allowed │ -│ for this configuration? │ -│ [default: allow-delete] │ -│ --auth-password TEXT ARLAS password │ -│ [default: None] │ -│ --elastic-password TEXT elasticsearch password │ -│ [default: None] │ -│ --help Show this message and │ -│ exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ - +Usage: arlas_cli confs login [OPTIONS] AUTH_LOGIN ELASTIC_LOGIN ELASTIC + + Add a configuration for ARLAS Cloud + +Arguments: + AUTH_LOGIN ARLAS login [required] + ELASTIC_LOGIN Elasticsearch login [required] + ELASTIC Elasticsearch url [required] + +Options: + --auth-org TEXT ARLAS IAM Organization, default is your + email domain name + --allow-delete / --no-allow-delete + Is delete command allowed for this + configuration? [default: allow-delete] + --auth-password TEXT ARLAS password + --elastic-password TEXT elasticsearch password + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` Only your own ES and ARLAS credentials have to be set, the configuration is directly linked to the ARLAS Cloud instance. @@ -225,19 +191,17 @@ An existing configuration can be deleted with the `confs delete` sub command: ```shell > arlas_cli confs delete --help - - Usage: arlas_cli confs delete [OPTIONS] CONFIG - - Delete a configuration - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * config TEXT Name of the configuration [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli confs delete [OPTIONS] CONFIG + + Delete a configuration + +Arguments: + CONFIG Name of the configuration [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ``` @@ -262,19 +226,17 @@ The content of a configuration can be detailed with `confs describe` sub command ```shell > arlas_cli confs describe --help - - Usage: arlas_cli confs describe [OPTIONS] CONFIG - - Describe a configuration - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * config TEXT Name of the configuration [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli confs describe [OPTIONS] CONFIG + Describe a configuration + +Arguments: + CONFIG Name of the configuration [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ``` @@ -324,15 +286,14 @@ The list of available configurations can be obtained with `confs list` sub comma ```shell > arlas_cli confs list --help - - Usage: arlas_cli confs list [OPTIONS] - - List configurations - -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli confs list [OPTIONS] + + List configurations + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ``` diff --git a/docs/docs/help.md b/docs/docs/help.md index fc6fd27..73bae58 100644 --- a/docs/docs/help.md +++ b/docs/docs/help.md @@ -6,28 +6,22 @@ Whether you are at the top level: ```shell > arlas_cli --help - - Usage: arlas_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 │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_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 + --help Show this message and exit. + +Commands: + collections + confs + iam + indices + persist ``` or within a sub command: @@ -35,31 +29,25 @@ or within a sub command: ```shell > arlas_cli indices --config local mapping --help - - Usage: arlas_cli indices mapping [OPTIONS] FILE - - Generate the mapping based on the data - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * file TEXT Path to the file containing the data. Format: NDJSON │ -│ [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --nb-lines INTEGER Number of line to consider for generating │ -│ the mapping. Avoid going over 10. │ -│ [default: 2] │ -│ --field-mapping TEXT Override the mapping with the provided │ -│ field path/type. Example: │ -│ fragment.location:geo_point. Important: │ -│ the full field path must be provided. │ -│ --no-fulltext TEXT List of keyword or text fields that should │ -│ not be in the fulltext search. Important: │ -│ the field name only must be provided. │ -│ --push-on TEXT Push the generated mapping for the │ -│ provided index name │ -│ [default: None] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices mapping [OPTIONS] FILE + + Generate the mapping based on the data + +Arguments: + FILE Path to the file containing the data. Format: NDJSON [required] + +Options: + --nb-lines INTEGER Number of line to consider for generating the mapping. + Avoid going over 10. [default: 2] + --field-mapping TEXT Override the mapping with the provided field + path/type. Example: fragment.location:geo_point. + Important: the full field path must be provided. + --no-fulltext TEXT List of keyword or text fields that should not be in + the fulltext search. Important: the field name only + must be provided. + --no-index TEXT List of fields that should not be indexed. + --push-on TEXT Push the generated mapping for the provided index name + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` diff --git a/docs/docs/iam.md b/docs/docs/iam.md index cd9176c..e839340 100644 --- a/docs/docs/iam.md +++ b/docs/docs/iam.md @@ -5,37 +5,29 @@ ```shell > arlas_cli iam --config local orgs --help - - Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]... - -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Commands ─────────────────────────────────────────────────────────────────╮ -│ add Create organisation with the given name │ -│ add_group Add a group to the organisation │ -│ add_permission Add a permission to the organisation │ -│ add_permission_to_group Add a permission to a group within the │ -│ organisation │ -│ add_user Add a user to the organisation, and │ -│ optionally within groups │ -│ add_user_to_group Add a user to a group within the │ -│ organisation │ -│ collections List the collections of the organisation │ -│ delete Delete the organisation │ -│ delete_group Remove the group from the organisation │ -│ delete_permission Remove the permission from the organisation │ -│ delete_permission_from_group Remove a permission to a group within the │ -│ organisation │ -│ delete_user Remove the user from the organisation │ -│ delete_user_from_group Remove a user from a group within the │ -│ organisation │ -│ groups List the groups of the organisation │ -│ list List organisations │ -│ permissions List the permissions of the organisation │ -│ users List the users of the organisation │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli iam orgs [OPTIONS] COMMAND [ARGS]... +Options: + --help Show this message and exit. + +Commands: + add Create organisation with the given name + add_group Add a group to the organisation + add_permission Add a permission to the organisation + add_permission_to_group Add a permission to a group within the... + add_user Add a user to the organisation, and... + add_user_to_group Add a user to a group within the... + collections List the collections of the organisation + delete Delete the organisation + delete_group Remove the group from the organisation + delete_permission Remove the permission from the organisation + delete_permission_from_group Remove a permission to a group within the... + delete_user Remove the user from the organisation + delete_user_from_group Remove a user from a group within the... + groups List the groups of the organisation + list List organisations + permissions List the permissions of the organisation + users List the users of the organisation ``` ## Create, delete, activate / deactivate users @@ -43,17 +35,14 @@ ```shell > arlas_cli iam --config local users --help - - Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]... - -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Commands ─────────────────────────────────────────────────────────────────╮ -│ activate Activate user account │ -│ add Create user │ -│ deactivate Deactivate user account │ -│ delete Delete user │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli iam users [OPTIONS] COMMAND [ARGS]... + +Options: + --help Show this message and exit. +Commands: + activate Activate user account + add Create user + deactivate Deactivate user account + delete Delete user ``` diff --git a/docs/docs/indices.md b/docs/docs/indices.md index 59c13b1..a71f995 100644 --- a/docs/docs/indices.md +++ b/docs/docs/indices.md @@ -12,29 +12,24 @@ An index contains the data and a [mapping](concepts.md#es-mapping) to describe h ```shell > arlas_cli indices --help - - Usage: arlas_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 │ -╰────────────────────────────────────────────────────────────────────────────╯ - +Usage: arlas_cli indices [OPTIONS] COMMAND [ARGS]... + +Options: + --config TEXT Name of the ARLAS configuration to use from your + configuration file + (/home/willi/.arlas/cli/configuration.yaml). + --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... + sample Display a sample of an index ``` ## mapping @@ -44,33 +39,27 @@ An index contains the data and a [mapping](concepts.md#es-mapping) to describe h ```shell > arlas_cli indices --config local mapping --help - - Usage: arlas_cli indices mapping [OPTIONS] FILE - - Generate the mapping based on the data - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * file TEXT Path to the file containing the data. Format: NDJSON │ -│ [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --nb-lines INTEGER Number of line to consider for generating │ -│ the mapping. Avoid going over 10. │ -│ [default: 2] │ -│ --field-mapping TEXT Override the mapping with the provided │ -│ field path/type. Example: │ -│ fragment.location:geo_point. Important: │ -│ the full field path must be provided. │ -│ --no-fulltext TEXT List of keyword or text fields that should │ -│ not be in the fulltext search. Important: │ -│ the field name only must be provided. │ -│ --push-on TEXT Push the generated mapping for the │ -│ provided index name │ -│ [default: None] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ - +Usage: arlas_cli indices mapping [OPTIONS] FILE + + Generate the mapping based on the data + +Arguments: + FILE Path to the file containing the data. Format: NDJSON [required] + +Options: + --nb-lines INTEGER Number of line to consider for generating the mapping. + Avoid going over 10. [default: 2] + --field-mapping TEXT Override the mapping with the provided field + path/type. Example: fragment.location:geo_point. + Important: the full field path must be provided. + --no-fulltext TEXT List of keyword or text fields that should not be in + the fulltext search. Important: the field name only + must be provided. + --no-index TEXT List of fields that should not be indexed. + --push-on TEXT Push the generated mapping for the provided index name + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Data file @@ -190,23 +179,20 @@ The `indices create` sub-function create the index from a mapping json file. ```shell > arlas_cli indices --config local create --help - - Usage: arlas_cli indices create [OPTIONS] INDEX - - Create an index - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * index TEXT index's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ * --mapping TEXT Name of the mapping within your │ -│ configuration, or URL or file path │ -│ [default: None] │ -│ [required] │ -│ --shards INTEGER Number of shards for the index [default: 1] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices create [OPTIONS] INDEX + + Create an index + +Arguments: + INDEX index's name [required] +Options: + --mapping TEXT Name of the mapping within your configuration, or URL or + file path [required] + --shards INTEGER Number of shards for the index [default: 1] + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Create an ES index with its mapping @@ -240,23 +226,20 @@ The `indices data` sub-function ingest the data in a given index. ```shell > arlas_cli indices --config local data --help - - Usage: arlas_cli indices data [OPTIONS] INDEX FILES... - - Index data - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * index TEXT index's name [default: None] [required] │ -│ * files FILES... List of paths to the file(s) containing the │ -│ data. Format: NDJSON │ -│ [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --bulk INTEGER Bulk size for indexing data [default: 5000] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices data [OPTIONS] INDEX FILES... + + Index data + +Arguments: + INDEX index's name [required] + FILES... List of paths to the file(s) containing the data. Format: NDJSON + [required] +Options: + --bulk INTEGER Bulk size for indexing data [default: 5000] + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Ingest data @@ -297,15 +280,14 @@ To list the available ES indices, simply use the `indices list` sub-function. No ```shell > arlas_cli indices --config local list --help - - Usage: arlas_cli indices list [OPTIONS] - - List indices - -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices list [OPTIONS] + + List indices + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### List available ES indices @@ -331,23 +313,20 @@ Once the index is created, the description of the fields it contains (correspond ```shell > arlas_cli indices --config local data --help - - Usage: arlas_cli indices data [OPTIONS] INDEX FILES... - - Index data - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * index TEXT index's name [default: None] [required] │ -│ * files FILES... List of paths to the file(s) containing the │ -│ data. Format: NDJSON │ -│ [default: None] │ -│ [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --bulk INTEGER Bulk size for indexing data [default: 5000] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices data [OPTIONS] INDEX FILES... + + Index data + +Arguments: + INDEX index's name [required] + FILES... List of paths to the file(s) containing the data. Format: NDJSON + [required] + +Options: + --bulk INTEGER Bulk size for indexing data [default: 5000] + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Describe the index mapping @@ -380,18 +359,17 @@ The first rows of the data contained in an index can be displayed with the `indi ```shell > arlas_cli indices --config local delete --help - - Usage: arlas_cli indices delete [OPTIONS] INDEX - - Delete an index - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * index TEXT index's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices delete [OPTIONS] INDEX + Delete an index + +Arguments: + INDEX index's name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Visualize few rows of your dataset @@ -427,19 +405,18 @@ An ES index can be cloned on the same ES deployment with the `indices clone` sub ```shell > arlas_cli indices --config local clone --help - - Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET - - Clone an index and set its name - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * source TEXT Source index name [default: None] [required] │ -│ * target TEXT Target cloned index name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET + + Clone an index and set its name + +Arguments: + SOURCE Source index name [required] + TARGET Target cloned index name [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` Both indices co-exist with exactly the same mapping and data content. @@ -458,19 +435,18 @@ The target configuration and the name of the new created index are given to the ```shell > arlas_cli indices --config local clone --help - - Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET - - Clone an index and set its name - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * source TEXT Source index name [default: None] [required] │ -│ * target TEXT Target cloned index name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices clone [OPTIONS] SOURCE TARGET + Clone an index and set its name + +Arguments: + SOURCE Source index name [required] + TARGET Target cloned index name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` Both indices co-exist with exactly the same mapping and data content. @@ -482,18 +458,17 @@ The ES index can be deleted with `indices delete` sub command to free space on t ```shell > arlas_cli indices --config local delete --help - - Usage: arlas_cli indices delete [OPTIONS] INDEX - - Delete an index - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * index TEXT index's name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli indices delete [OPTIONS] INDEX + + Delete an index + +Arguments: + INDEX index's name [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Delete an ES index diff --git a/docs/docs/persist.md b/docs/docs/persist.md index ea458aa..e06cbd3 100644 --- a/docs/docs/persist.md +++ b/docs/docs/persist.md @@ -15,25 +15,21 @@ An entry is an element stored in the persistence. ```shell > arlas_cli persist --help - - Usage: arlas_cli persist [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 ─────────────────────────────────────────────────────────────────╮ -│ add Add an entry, returns its ID │ -│ delete Delete an entry │ -│ describe Describe an entry │ -│ get Retrieve an entry │ -│ groups List groups allowed to access a zone │ -│ zone List entries within a zone │ -╰────────────────────────────────────────────────────────────────────────────╯ - +Usage: arlas_cli persist [OPTIONS] COMMAND [ARGS]... + +Options: + --config TEXT Name of the ARLAS configuration to use from your + configuration file + (/home/willi/.arlas/cli/configuration.yaml). + --help Show this message and exit. + +Commands: + add Add an entry, returns its ID + delete Delete an entry + describe Describe an entry + get Retrieve an entry + groups List groups allowed to access a zone + zone List entries within a zone ``` ## add @@ -43,23 +39,22 @@ The `persist add` sub-command allows to create an entry from a file. ```shell > arlas_cli persist --config local add --help - - Usage: arlas_cli persist add [OPTIONS] FILE ZONE - - Add an entry, returns its ID - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * file TEXT File path [default: None] [required] │ -│ * zone TEXT zone [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --name TEXT name [default: none] │ -│ --reader TEXT Readers │ -│ --writer TEXT writers │ -│ --encode --no-encode Encode in BASE64 [default: no-encode] │ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist add [OPTIONS] FILE ZONE + + Add an entry, returns its ID + +Arguments: + FILE File path [required] + ZONE zone [required] +Options: + --name TEXT name [default: none] + --reader TEXT Readers + --writer TEXT writers + --encode / --no-encode Encode in BASE64 [default: no-encode] + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Add an entry from a file @@ -87,18 +82,17 @@ The available entries in a zone can be listed with the `persist zone` sub-comman ```shell > arlas_cli persist --config local zone --help - - Usage: arlas_cli persist zone [OPTIONS] ZONE - - List entries within a zone - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * zone TEXT Zone name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist zone [OPTIONS] ZONE + + List entries within a zone +Arguments: + ZONE Zone name [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### List entries within a zone @@ -125,18 +119,17 @@ An entry (defined by its unique identifier) can be described with the `persist d ```shell > arlas_cli persist --config local describe --help - - Usage: arlas_cli persist describe [OPTIONS] ID - - Describe an entry - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * id TEXT entry identifier [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist describe [OPTIONS] ID + + Describe an entry + +Arguments: + ID entry identifier [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Describe an entry @@ -171,18 +164,17 @@ The content of an entry can be accessed with the `persist get` sub-command: ```shell > arlas_cli persist --config local get --help - - Usage: arlas_cli persist get [OPTIONS] ID - - Retrieve an entry - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * id TEXT entry identifier [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist get [OPTIONS] ID + Retrieve an entry + +Arguments: + ID entry identifier [required] + +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Get an entry value @@ -207,18 +199,17 @@ The groups accessing a zone can be listed with the `persist groups` sub-command: ```shell > arlas_cli persist --config local groups --help - - Usage: arlas_cli persist groups [OPTIONS] ZONE - - List groups allowed to access a zone - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * zone TEXT Zone name [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist groups [OPTIONS] ZONE + + List groups allowed to access a zone + +Arguments: + ZONE Zone name [required] +Options: + --help Show this message and exit. + + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### List groups accessing a zone @@ -243,18 +234,17 @@ An entry defined by its unique identifier can be deleted with the `persist delet ```shell > arlas_cli persist --config local delete --help - - Usage: arlas_cli persist delete [OPTIONS] ID - - Delete an entry - -╭─ Arguments ────────────────────────────────────────────────────────────────╮ -│ * id TEXT entry identifier [default: None] [required] │ -╰────────────────────────────────────────────────────────────────────────────╯ -╭─ Options ──────────────────────────────────────────────────────────────────╮ -│ --help Show this message and exit. │ -╰────────────────────────────────────────────────────────────────────────────╯ +Usage: arlas_cli persist delete [OPTIONS] ID + + Delete an entry + +Arguments: + ID entry identifier [required] + +Options: + --help Show this message and exit. + See full arlas_cli documentation at https://gisaia.github.io/arlas_cli/ ``` ### Delete an entry diff --git a/docs/site/404.html b/docs/site/404.html index d713166..41eca42 100644 --- a/docs/site/404.html +++ b/docs/site/404.html @@ -16,7 +16,7 @@ - + @@ -24,7 +24,7 @@ - + @@ -48,7 +48,7 @@ - + @@ -86,12 +86,12 @@ - +