| Name | arlas-cli JSON |
| Version |
26.2.4
JSON |
| download |
| home_page | None |
| Summary | ARLAS Command line for ARLAS Management |
| upload_time | 2024-12-05 23:34:36 |
| 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.
--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
(/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
```
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
(/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
```
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:
create Add a configuration
delete Delete a configuration
describe Describe a configuration
list List configurations
login Add a configuration for ARLAS Cloud
```
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/7a/01/6f75176ef199e669a841f6f777de42f0ecaa5addaa5c6c2c8f8cea08fd81/arlas_cli-26.2.4.tar.gz",
"platform": null,
"description": "# ARLAS Command line for collection management\n\n```\npython3 -m arlas.cli.cli --help\nUsage: python -m arlas.cli.cli [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --config-file TEXT Path to the configuration file if you do not\n want to use the default one:\n .arlas/cli/configuration.yaml.\n --print-curl / --no-print-curl Print curl command [default: no-print-curl]\n --version Print command line version\n --help Show this message and exit.\n\nCommands:\n collections\n confs\n iam\n indices\n persist\n```\n\nActions on collections:\n\n```\npython3 -m arlas.cli.cli collections --help\nUsage: python -m arlas.cli.cli collections [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --config TEXT Name of the ARLAS configuration to use from your\n configuration file\n (/home/willi/.arlas/cli/configuration.yaml).\n --help Show this message and exit.\n\nCommands:\n count Count the number of hits within a collection (or all...\n create Create a collection\n delete Delete a collection\n describe Describe a collection\n list List collections\n name Set the collection display name\n private Set collection visibility to private\n public Set collection visibility to public\n sample Display a sample of a collection\n set_alias Set the field display name\n share Share the collection with the organisation\n unshare Unshare the collection with the organisation\n```\n\nActions on indices:\n\n```\npython3 -m arlas.cli.cli indices --help\nUsage: python -m arlas.cli.cli indices [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --config TEXT Name of the ARLAS configuration to use from your\n configuration file\n (/home/willi/.arlas/cli/configuration.yaml).\n --help Show this message and exit.\n\nCommands:\n clone Clone an index and set its name\n create Create an index\n data Index data\n delete Delete an index\n describe Describe an index\n list List indices\n mapping Generate the mapping based on the data\n migrate Migrate an index on another arlas configuration, and set the...\n sample Display a sample of an index\n```\n\nActions on configurations:\n\n```\npython3 -m arlas.cli.cli confs --help\nUsage: python -m arlas.cli.cli confs [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n --help Show this message and exit.\n\nCommands:\n create Add a configuration\n delete Delete a configuration\n describe Describe a configuration\n list List configurations\n login Add a configuration for ARLAS Cloud\n```\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "ARLAS Command line for ARLAS Management",
"version": "26.2.4",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "98c89a04febf9c3dc8292257b9217e729784f00e359a704fee9f04884d745207",
"md5": "40ada8d535e8e5a534378ee0c77b1f49",
"sha256": "b4e960f9784c6c7a60ea169a9371350a7c44e7843d53b05d14f8f80e2241f2e4"
},
"downloads": -1,
"filename": "arlas_cli-26.2.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "40ada8d535e8e5a534378ee0c77b1f49",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 22767,
"upload_time": "2024-12-05T23:34:34",
"upload_time_iso_8601": "2024-12-05T23:34:34.759479Z",
"url": "https://files.pythonhosted.org/packages/98/c8/9a04febf9c3dc8292257b9217e729784f00e359a704fee9f04884d745207/arlas_cli-26.2.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7a016f75176ef199e669a841f6f777de42f0ecaa5addaa5c6c2c8f8cea08fd81",
"md5": "e9d96d2976325f4522516ca4921e0be6",
"sha256": "418fdbc3f02bf674998862452a094baed1153f33bc0faaeb923a65688926d00f"
},
"downloads": -1,
"filename": "arlas_cli-26.2.4.tar.gz",
"has_sig": false,
"md5_digest": "e9d96d2976325f4522516ca4921e0be6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 18356,
"upload_time": "2024-12-05T23:34:36",
"upload_time_iso_8601": "2024-12-05T23:34:36.558588Z",
"url": "https://files.pythonhosted.org/packages/7a/01/6f75176ef199e669a841f6f777de42f0ecaa5addaa5c6c2c8f8cea08fd81/arlas_cli-26.2.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-05 23:34:36",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "arlas-cli"
}
