[](https://github.com/alertlogic/alcli/actions)
[](https://github.com/alertlogic/alcli/actions)
[](https://badge.fury.io/py/alcli)
# Installing the Alert Logic CLI
The `pip` package manager for Python is used to install, upgrade and remove Alert Logic CLI.
## **Installing the current version of the Alert Logic CLI**
Alert Logic CLI only works on Python 3.7 or higher.
Please follow this instructions on how to install Python on your system: <https://www.python.org/downloads/>
Use `pip3` to install the Alert Logic CLI
$ pip3 install alcli --upgrade --user
Make sure to use `--user` to to install the program to a subdirectory of your user directory to avoid modifying libraries used by your operating system.
### Windows installer
For windows users there is self-contained Alert Logic CLI distribution is available, please download latest version from here:
* [executable installation package](https://github.com/alertlogic/alcli/releases/latest/download/AlertlogicCLISetup.exe)
* [msi installation package](https://github.com/alertlogic/alcli/releases/latest/download/AlertlogicCLISetup.msi)
Alternatively, please view [history](https://github.com/alertlogic/alcli/releases/) of the releases.
## **Upgrading to the latest version of the Alert Logic CLI**
We regularly introduce support for new Alert Logic services.
We recommend that you check installed packages version and upgrade to the latest version regularly.
```
$ pip3 install --upgrade --force-reinstall alcli
```
## Configure the Alert Logic CLI with Your Credentials
Before you can run a CLI command, you must configure the Alert Logic's CLI with your credentials.
By default, `alcli` uses ~/.alertlogic/config configuration file in a user's home directory. File can contain multiple profiles. Here's an example of a configuration file that has credentials for an integration and production deployments:
[default]
access_key_id=1111111111111111
secret_key=eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee
global_endpoint=integration
[production]
access_key_id=2222222222222222
secret_key=dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd
global_endpoint=production
The location of the configuration file can be also specified by setting `ALERTLOGIC_CONFIG` environment variable to contain file's location.
## Notes:
`--query` option requires JMESPath language expression. See
<http://jmespath.org/tutorial.html> for language tutorial.
=======
History
=======
1.0.1 (2020-02-06)
------------------
* First release on PyPI.
1.0.7 (2020-02-07)
------------------
* First version of main help page and bug fixes.
Raw data
{
"_id": null,
"home_page": "https://github.com/alertlogic/alcli",
"name": "alcli",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "alcli,almdr,alertlogic,alertlogic-cli",
"author": "Alert Logic Inc.",
"author_email": "devsupport@alertlogic.com",
"download_url": "https://files.pythonhosted.org/packages/47/11/9ad2ca351afcb710adc2adcd8d582ebbc7c72d6ad724308bab4d69be4fb5/alcli-1.0.65.tar.gz",
"platform": "any",
"description": "\n[](https://github.com/alertlogic/alcli/actions)\n[](https://github.com/alertlogic/alcli/actions)\n[](https://badge.fury.io/py/alcli)\n\n# Installing the Alert Logic CLI\nThe `pip` package manager for Python is used to install, upgrade and remove Alert Logic CLI.\n\n## **Installing the current version of the Alert Logic CLI**\n\nAlert Logic CLI only works on Python 3.7 or higher. \nPlease follow this instructions on how to install Python on your system: <https://www.python.org/downloads/>\n\n\nUse `pip3` to install the Alert Logic CLI\n\n $ pip3 install alcli --upgrade --user\n\n\nMake sure to use `--user` to to install the program to a subdirectory of your user directory to avoid modifying libraries used by your operating system.\n\n### Windows installer\n\nFor windows users there is self-contained Alert Logic CLI distribution is available, please download latest version from here: \n* [executable installation package](https://github.com/alertlogic/alcli/releases/latest/download/AlertlogicCLISetup.exe)\n* [msi installation package](https://github.com/alertlogic/alcli/releases/latest/download/AlertlogicCLISetup.msi)\n\nAlternatively, please view [history](https://github.com/alertlogic/alcli/releases/) of the releases. \n\n## **Upgrading to the latest version of the Alert Logic CLI**\nWe regularly introduce support for new Alert Logic services.\nWe recommend that you check installed packages version and upgrade to the latest version regularly.\n\n```\n$ pip3 install --upgrade --force-reinstall alcli\n```\n\n## Configure the Alert Logic CLI with Your Credentials\nBefore you can run a CLI command, you must configure the Alert Logic's CLI with your credentials.\n\nBy default, `alcli` uses ~/.alertlogic/config configuration file in a user's home directory. File can contain multiple profiles. Here's an example of a configuration file that has credentials for an integration and production deployments:\n\n [default]\n\taccess_key_id=1111111111111111\n\tsecret_key=eeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeeee\n\tglobal_endpoint=integration\n\t\n\t[production]\n\taccess_key_id=2222222222222222\n\tsecret_key=dddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddddd\n\tglobal_endpoint=production\n\n\nThe location of the configuration file can be also specified by setting `ALERTLOGIC_CONFIG` environment variable to contain file's location.\n\n## Notes:\n`--query` option requires JMESPath language expression. See \n<http://jmespath.org/tutorial.html> for language tutorial.\n\n\n\n=======\nHistory\n=======\n\n1.0.1 (2020-02-06)\n------------------\n\n* First release on PyPI.\n\n1.0.7 (2020-02-07)\n------------------\n\n* First version of main help page and bug fixes.\n",
"bugtrack_url": null,
"license": "MIT license",
"summary": "The Alert Logic Command Line Utility (CLI).",
"version": "1.0.65",
"project_urls": {
"Homepage": "https://github.com/alertlogic/alcli"
},
"split_keywords": [
"alcli",
"almdr",
"alertlogic",
"alertlogic-cli"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8ee63ab5b1e70510fbcc13a018067dfdae555de46586e9480c42a5b3a3e28c6c",
"md5": "ebeea2ca907bcb7c69790b15848fd7d0",
"sha256": "fb9103689fe634ca523c3847232ad60d9d7cb13e3ebc74cf3f87e33941d67bde"
},
"downloads": -1,
"filename": "alcli-1.0.65-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ebeea2ca907bcb7c69790b15848fd7d0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 15410,
"upload_time": "2023-05-16T16:47:52",
"upload_time_iso_8601": "2023-05-16T16:47:52.072205Z",
"url": "https://files.pythonhosted.org/packages/8e/e6/3ab5b1e70510fbcc13a018067dfdae555de46586e9480c42a5b3a3e28c6c/alcli-1.0.65-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "47119ad2ca351afcb710adc2adcd8d582ebbc7c72d6ad724308bab4d69be4fb5",
"md5": "7245a9275a3b33038067a1708b7d5f8a",
"sha256": "169f15777c71c8b346ea78d0750b6ad0706a2af350ab446bc01a3eb526eb5d7f"
},
"downloads": -1,
"filename": "alcli-1.0.65.tar.gz",
"has_sig": false,
"md5_digest": "7245a9275a3b33038067a1708b7d5f8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 87219,
"upload_time": "2023-05-16T16:47:53",
"upload_time_iso_8601": "2023-05-16T16:47:53.882396Z",
"url": "https://files.pythonhosted.org/packages/47/11/9ad2ca351afcb710adc2adcd8d582ebbc7c72d6ad724308bab4d69be4fb5/alcli-1.0.65.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-05-16 16:47:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "alertlogic",
"github_project": "alcli",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "alcli"
}
JSON
