Skip to content

Commit

Permalink
ARLAS Command line 26.2.3-beta.1
Browse files Browse the repository at this point in the history
  • Loading branch information
@WilliGautier
WilliGautier committed Dec 5, 2024
1 parent 96d9d1d commit 9a912ce
Show file tree
Hide file tree
Showing 87 changed files with 3,725 additions and 1,520 deletions.
14 changes: 13 additions & 1 deletion README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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`
### 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}
```
341 changes: 152 additions & 189 deletions docs/docs/collections.md
View file

Large diffs are not rendered by default.

219 changes: 90 additions & 129 deletions docs/docs/confs.md
View file

Large diffs are not rendered by default.

82 changes: 35 additions & 47 deletions docs/docs/help.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,60 +6,48 @@ Whether you are at the top level:
<!-- termynal -->
```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:
<!-- termynal -->
```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/
```
73 changes: 31 additions & 42 deletions docs/docs/iam.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,55 +5,44 @@
<!-- termynal -->
```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

<!-- termynal -->
```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
```
Loading

0 comments on commit 9a912ce

Please sign in to comment.