Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/anowell/mia
Experimental Algorithmia CLI (no longer the official CLI)
https://github.com/anowell/mia
algorithms
Last synced: about 1 month ago
JSON representation
Experimental Algorithmia CLI (no longer the official CLI)
- Host: GitHub
- URL: https://github.com/anowell/mia
- Owner: anowell
- Created: 2015-03-19T20:23:02.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2021-01-12T08:16:49.000Z (almost 4 years ago)
- Last Synced: 2023-04-09T06:14:27.504Z (over 1 year ago)
- Topics: algorithms
- Language: Rust
- Homepage:
- Size: 1.01 MB
- Stars: 41
- Watchers: 24
- Forks: 5
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
**THE OFFICIAL ALGORITHMIA CLI HAS MOVED TO https://github.com/algorithmiaio/algorithmia-python**
This repo is now for experimenting with CLI-based interactions with Algorithmia and the Algorithmia rust client. To clearly disambiguate from `algo`, the official Algorithmia CLI, this project is changing its name to `mia`.
mia
---------------------
[](https://travis-ci.org/anowell/mia)
mia is a cross-platform tool for interfacing with algorithms and the Algorithmia Data API.
## Installing mia
The latest releases & changelog can be found [here](https://github.com/anowell/mia/releases/latest).
**Linux and OSX**
Install is by running:
```bash
curl -sSLf https://raw.githubusercontent.com/anowell/mia/master/install.sh | sh
```
**Windows**
Download and extract the [latest Windows x86_64 zip file](https://github.com/anowell/mia/releases/download/v1.0.1/algorithmia-v1.0.1-x86_64-pc-windows-msvc.zip). We recommend putting it within your `PATH`.
If needed, you can also find both MSVC and GNU builds for x86 and x86_64 on the [release page](https://github.com/anowell/mia/releases/latest).
## Alternate Installation Methods
**Debian/Ubuntu**
For our Debian/Ubuntu users, a `.deb` package is also available for installation with `dpkg`. Simply run the following:
```bash
curl -OL https://github.com/anowell/mia/releases/download/v1.0.1/algorithmia-v1.0.1-x86_64-unknown-linux-gnu.deb
sudo dpkg -i algorithmia-v1.0.1-x86_64-unknown-linux-gnu.deb
```
**Arch**
Arch packages available on the AUR as [algorithmia-bin](https://aur4.archlinux.org/packages/algorithmia-bin/) and [algorithmia-git](https://aur4.archlinux.org/packages/algorithmia-git/). Use your favorite AUR helper (e.g. `aura`):
```bash
aura -A algorithmia-bin
```
## Configure Authentication
In order to make calls with the CLI, you'll need to configure the authentication with an API key. If you don't already have an API key, get started by signing up for an account at [Algorithmia.com](https://algorithmia.com). Once you've completed the sign up process, copy the API key from your account dashboard.
Begin the configuration process by running the command `mia auth`.
You will see an interactive prompt to guide you through setting up a default profile:
```
$ mia auth
Configuring authentication for 'default' profile
Enter API Endpoint [https://api.algorithmia.com]:
Enter API Key (prefixed with 'sim'):
Profile is ready to use. Test with 'mia ls'
```
See [Using multiple profiles](#using-multiple-profiles) for instructions on how to set authenticate and use more than one profile with the Algorithmia CLI tool.
## Usage
To call an algorithm from the CLI, use the command syntax: `mia run`, followed by the algorithm’s username and algorithm name, the data options, and finally the input. Here is a basic example calling the [Factor algorithm](https://algorithmia.com/algorithms/kenny/Factor):
```text
$ mia run kenny/factor -d 19635
[3,5,7,11,17]
```
Add the option `--response-body` to see the full JSON response:
```text
$ mia run kenny/factor -d 19635 --response-body
{"result":[3,5,7,11,17],"metadata":{"content_type":"json","duration":0.001427314}}
```
Run `mia run --help` to see more command options or view the following [Options](#options) section.
### Options
#### Input Data Options
There are several options for specifying the type and source of input data. The Algorithmia CLI supports JSON, text, and binary data, as well as an option to auto-detect the data type.
| Option Flag | Description |
| :------------ | :--------------- |
| -d, --data | If the data parses as JSON, assume JSON, else if the data is valid UTF-8, assume text, else assume binary |
| -D, --data-file | Same as --data, but the input data is read from a file |
You may also explictly specify the input type as text (`-t`/`-T`), json (`-j`/`-J`), or binary (`-b`/`-B`) instead of using the auto-detection (`-d`/`-D`).
#### Output Options
The algorithm result is printed to STDOUT by defauft. Additional notices may be printed to STDERR. If you'd like to output the result to a file, use the output option flag followed by a filename:
```text
$ mia run kenny/factor -d 17 --output results.txt
```
| Option Flag | Description |
| :------------ |:--------------- |
| --debug | Print algorithm's STDOUT (author-only) |
| --response-body | Print HTTP response body (replaces result) |
| --response | Print full HTTP response including headers (replaces result) |
| -s, --silence | Suppress any output not explicitly requested (except result) |
| -o, --output | Print result to a file |
#### Other Options
| Option Flag | Description |
| :------------ |:--------------- |
| --timeout | Sets algorithm timeout
#### Examples:
```text
$ mia run kenny/factor/0.1.0 -d '79' Run algorithm with specified version & data input
$ mia run anowell/Dijkstra -D routes.json Run algorithm with file input
$ mia run anowell/Dijkstra -D - < routes.json Same as above but using STDIN
$ mia run opencv/SmartThumbnail -D in.png -o out.png Runs algorithm with binary files as input
$ mia run kenny/factor -d 17 --timeout 2 Runs algorithm with a timeout of 2 seconds
```
## The Algorithmia Data API
Use the Algorithmia CLI to interact with the Algorithmia Data API. You can use the CLI to create and manage your data directories.
**Data commands include:**
| Command | Description |
| :------------ |:--------------- |
| ls | List contents of a data directory |
| mkdir | Create a data directory |
| rmdir | Delete a data directory |
| rm | Remove a file from a data directory |
| cp | Copy file(s) to or from a data directory |
| cat | Concatenate & print file(s) in a directory |
### Examples of the Algorithmia Data API usage:
Create a data directory:
```text
$ mia mkdir .my/cuteAnimals
Created directory data://.my/cuteAnimals
```
Copy a file from your local directory to the new data directory:
```text
$ mia cp chubby_kittens.jpg data://.my/cuteAnimals
Uploaded data://.my/cuteAnimals/chubby_kittens.jpg
```
## Using multiple profiles
### Add additional profiles
With the Algorithmia CLI, you can configure multiple custom profiles to use. To add a new profile, simply specify a profile to `mia auth` follow the same interactive prompt.
```text
$ mia auth --profile second_user
Configuring authentication for 'second_user' profile
Enter API Key (prefixed with 'sim'):
Profile is ready to use. Test with 'mia ls --profile second_user'
```
Now you may use `mia ls --profile second_user` to list files in your `second_user` account. For more information, see the auth command help with `mia auth --help`.
### Using profiles in commands
When running commands, the Algorithmia CLI will use the default profile unless otherwise specified with the `--profile ` option. See the following example:
```text
$ mia run kenny/factor -d 17 --profile second_user
[17]
```
## Build & Test
This project is built and tested with cargo:
```bash
cargo build
cargo test
```