| Name | arlas-cli JSON |
| Version |
26.3.7
JSON |
| download |
| home_page | None |
| Summary | ARLAS Command line for ARLAS Management |
| upload_time | 2025-02-20 10:38:47 |
| maintainer | None |
| docs_url | None |
| author | Gisaïa |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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 ─────────────────────────────────────────────────────────────────╮
│ check Check the services of a configuration │
│ create Add a configuration │
│ default Display the default configuration │
│ delete Delete a configuration │
│ describe Describe a configuration │
│ list List configurations │
│ login Add a configuration for ARLAS Cloud │
│ set Set default configuration among existing configurations │
╰────────────────────────────────────────────────────────────────────────────╯
```
Raw data
{
"_id": null,
"home_page": null,
"name": "arlas-cli",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "Gisa\u00efa",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/46/89/3b6efbf53d6d6248688d13994cc242e8a78bb0215a17e71d795541b1b55c/arlas_cli-26.3.7.tar.gz",
"platform": null,
"description": "# ARLAS Command line for collection management\n\n```\npython3 -m arlas.cli.cli --help\n\n Usage: python -m arlas.cli.cli [OPTIONS] COMMAND [ARGS]... \n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --config-file TEXT Path to the configuration file \u2502\n\u2502 if you do not want to use the \u2502\n\u2502 default one: \u2502\n\u2502 .arlas/cli/configuration.yaml. \u2502\n\u2502 [default: None] \u2502\n\u2502 --print-curl --no-print-curl Print curl command \u2502\n\u2502 [default: no-print-curl] \u2502\n\u2502 --version Print command line version \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 collections \u2502\n\u2502 confs \u2502\n\u2502 iam \u2502\n\u2502 indices \u2502\n\u2502 persist \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n```\n\nActions on collections:\n\n```\npython3 -m arlas.cli.cli collections --help\n\n Usage: python -m arlas.cli.cli collections [OPTIONS] COMMAND [ARGS]... \n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\n\u2502 configuration file \u2502\n\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\n\u2502 [default: None] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 count Count the number of hits within a collection (or all collection \u2502\n\u2502 if not provided) \u2502\n\u2502 create Create a collection \u2502\n\u2502 delete Delete a collection \u2502\n\u2502 describe Describe a collection \u2502\n\u2502 list List collections \u2502\n\u2502 name Set the collection display name \u2502\n\u2502 private Set collection visibility to private \u2502\n\u2502 public Set collection visibility to public \u2502\n\u2502 sample Display a sample of a collection \u2502\n\u2502 set_alias Set the field display name \u2502\n\u2502 share Share the collection with the organisation \u2502\n\u2502 unshare Unshare the collection with the organisation \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n```\n\nActions on indices:\n\n```\npython3 -m arlas.cli.cli indices --help\n\n Usage: python -m arlas.cli.cli indices [OPTIONS] COMMAND [ARGS]... \n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --config TEXT Name of the ARLAS configuration to use from your \u2502\n\u2502 configuration file \u2502\n\u2502 (/Users/gaudan/.arlas/cli/configuration.yaml). \u2502\n\u2502 [default: None] \u2502\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 clone Clone an index and set its name \u2502\n\u2502 create Create an index \u2502\n\u2502 data Index data \u2502\n\u2502 delete Delete an index \u2502\n\u2502 describe Describe an index \u2502\n\u2502 list List indices \u2502\n\u2502 mapping Generate the mapping based on the data \u2502\n\u2502 migrate Migrate an index on another arlas configuration, and set the \u2502\n\u2502 target index name \u2502\n\u2502 sample Display a sample of an index \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n```\n\nActions on configurations:\n\n```\npython3 -m arlas.cli.cli confs --help\n\n Usage: python -m arlas.cli.cli confs [OPTIONS] COMMAND [ARGS]... \n\n\u256d\u2500 Options \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 --help Show this message and exit. \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\u256d\u2500 Commands \u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256e\n\u2502 check Check the services of a configuration \u2502\n\u2502 create Add a configuration \u2502\n\u2502 default Display the default configuration \u2502\n\u2502 delete Delete a configuration \u2502\n\u2502 describe Describe a configuration \u2502\n\u2502 list List configurations \u2502\n\u2502 login Add a configuration for ARLAS Cloud \u2502\n\u2502 set Set default configuration among existing configurations \u2502\n\u2570\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u2500\u256f\n\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "ARLAS Command line for ARLAS Management",
"version": "26.3.7",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "158f937eb9c55d2c54727bd1704143b0ef61188068f2a2364aeddcfab34d27b9",
"md5": "83b2a714b8068b19c0b6caa19f4cd0f8",
"sha256": "1a75b9150cbe3970b0f92ec906a729ace0c85200023969a789a33ef952a5b40c"
},
"downloads": -1,
"filename": "arlas_cli-26.3.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "83b2a714b8068b19c0b6caa19f4cd0f8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 24801,
"upload_time": "2025-02-20T10:38:46",
"upload_time_iso_8601": "2025-02-20T10:38:46.268360Z",
"url": "https://files.pythonhosted.org/packages/15/8f/937eb9c55d2c54727bd1704143b0ef61188068f2a2364aeddcfab34d27b9/arlas_cli-26.3.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "46893b6efbf53d6d6248688d13994cc242e8a78bb0215a17e71d795541b1b55c",
"md5": "28d34667f3275983267ea52d438e3035",
"sha256": "fe519bb4cd8f6934b8a8feb994ed58160d4f4a8519cb95a22cdb91c244612bf8"
},
"downloads": -1,
"filename": "arlas_cli-26.3.7.tar.gz",
"has_sig": false,
"md5_digest": "28d34667f3275983267ea52d438e3035",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20588,
"upload_time": "2025-02-20T10:38:47",
"upload_time_iso_8601": "2025-02-20T10:38:47.460228Z",
"url": "https://files.pythonhosted.org/packages/46/89/3b6efbf53d6d6248688d13994cc242e8a78bb0215a17e71d795541b1b55c/arlas_cli-26.3.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-02-20 10:38:47",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "arlas-cli"
}
