Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anaconda/ae5-tools
A command-line tool for scripting AE5 actions
https://github.com/anaconda/ae5-tools
Last synced: about 1 month ago
JSON representation
A command-line tool for scripting AE5 actions
- Host: GitHub
- URL: https://github.com/anaconda/ae5-tools
- Owner: anaconda
- License: bsd-3-clause
- Created: 2019-05-03T16:23:47.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-11-12T20:02:04.000Z (about 2 months ago)
- Last Synced: 2024-11-12T20:32:02.554Z (about 2 months ago)
- Language: Python
- Homepage: https://www.anaconda.com/enterprise/
- Size: 886 KB
- Stars: 9
- Watchers: 11
- Forks: 8
- Open Issues: 27
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
# AE5 Command Line Tool
[](https://github.com/Anaconda-Platform/ae5-tools/actions) [](https://anaconda.org/ae5-admin/ae5-tools) [](https://anaconda.org/ae5-admin/ae5-tools)
## Overview
This tool uses AE5's internal APIs to do cool things, including:
- obtaining information about projects, sessions, deployments, jobs, and runs
- starting and stopping sessions and deployments
- uploading and downloading projects
More to come. The intent is also to make it possible to allow packages to plug into the tool and provide additional commands.
There is already a fair amount of inline help, so type `ae5 --help` to get started.
## Articles
For k8s service integration refer to:
* [k8s Service Component Documentation](docs/source/K8S_SERVER.md)
* [Project Commands Documentation](docs/source/COMMANDS.md)
* [Contributing](CONTRIBUTING.md)
## Installation
The preferred and supported way to install `ae5-tools` is with `conda`. The latest version of the tool
is always available on the [`ae5-admin` channel on anaconda.org](https://anaconda.org/ae5-admin/ae5-tools).
To install this package, you can use this command:
```
conda install -c https://conda.anaconda.org/ae5-admin ae5-tools
```
If you want the _unsupported, bleeding-edge, development_ version, use this command:
```
conda install -c https://conda.anaconda.org/ae5-admin/label/dev ae5-tools
```
The package has the following particular dependencies:
- Python 3.8 or later.
- [click](https://click.palletsprojects.com/en/7.x/) 7.0 or later
- [click-repl](https://github.com/click-contrib/click-repl)
## General Capabilities
- Adoption of a standard project identifier format `//:`, with convenient defaults:
- `` can usually be omitted, leaving `/:`
- `` can be omitted in most contexts, with the latest revision considered by default; the latest revision can also be specified with `:latest`, Docker-style
- `` can be also be omitted, allowing projects to be specified solely by `` or ``. The ambiguity of these choices is resolved by assuming no project will have a name matching the `` format `a[0-3]-[0-9a-f]{32}`.
- Output formats include terminal-formatted text tables, CSV files, and JSON.
- All tabular output can be filtered by simple field matching, and sorted by columns.
- Hostname, username, and password can be specified as command-line options or as environment variables, to facilitate programmatic use.
- Login sessions are persisted to `~/.ae5`, so that multiple commands can be issued without having to re-enter passwords.
- Keycloak impersonation allows administrators to run commands on behalf of them.
- A REPL mode provided by [click-repl](https://github.com/click-contrib/click-repl) be entered by typing `ae5` with no positional arguments, enabling multiple commands to be entered in a single session, with autocompletion, inline help, and persistent history.
## Command Tree
- Composite commands:
- `account`: `list`
- `deployment`: `info`, `list`, `logs`, `open`, `patch`, `restart`, `start`, `stop`, `token`
- `collaborator`: `list`, `info`, `add`, `remove`
- `editor`: `info`, `list`
- `endpoint`: `info`, `list`
- `job`: `create`, `delete`, `info`, `list`, `patch`, `run`, `runs`, `unpause`
- `project`: `activity`, `delete`, `deploy`, `deployments`, `download`, `info`, `jobs`,
`list`, `patch`, `run`, `runs`, `schedule`, `sessions`, `status`, `upload`
- `collaborator`: `add`, `info`, `list`, `remove`
- `revision`: `list`, `info`, `download`
- `sample`: `info`, `list`
- `secret`: `list`, `add`, `delete`
- `role`: `add`, `remove`
- `run`: `delete`, `info`, `list`, `log`, `stop`
- `session`: `branches`, `changes`, `info`, `list`, `open`, `start`, `stop`
- `user`: `info`, `list`, `create`, `delete`
- Simple commands: `call`, `login`, `logout`
- Login options: `--hostname`, `--username`, `--admin-username`, `--admin-hostname`, `--impersonate`
- Output format options: `--format`, `--filter`, `--columns`, `--sort`, `--width`, `--wide`, `--no-header`
- Help options: `--help-format`, `--help-filter`, `--help-login`, `--help`
## Support
We use this tool internally, so we're grateful for your feedback and look forward to continuously
improving it! To submit a bug report or feature request, please use our GitHub
[issue tracker](https://github.com/Anaconda-Platform/ae5-tools/issues). We will address these issues
as time permits. Rapid response support and prioritized feature development can be provided as part
of a paid engagement with our Services team. Please contact your Customer Success Manager for details.