Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: cloudmonkey tabular output

...

  • Usable as a command line tool and interactive shell
  • All commands are lowercase unlike API
  • Precached APIs, doc strings and params
  • Raw api execution support
  • Auto-completion via double <tab>
  • Reverse search using Ctrl+R
  • Emacs compatible keybindings
  • Pipeable output
  • Unix shell execution
  • Support to handle async jobs using user defined blocking or non-blocking way
  • Tabular output
  • Colored output

Installation

...

Key

Purpose

Default

host

IP or resolvable domain of management server

localhost

port

Api server port, 8080 is encouraged over 8096

8080

protocol

Specifies http or https

http

path

Specifies the absolute path to the api on the specified host

/client/api

apikey

User api key

""

secretkey

User secret key

""

prompt

cloudmonkey prompt, default prompt has a UTF-8 char which can be an issue

🐵 cloudmonkey>

asyncblock

Poll for async commands, making it false will cause cloudmonkey to return jobid

true

timeout

Timeout interval for polling async commands

3600

color

Enable coloured output, set to false to disable

true

tabularize

Enable tabular output, set to true to ensable

false

log_file

Log file

~/.cloudmonkey_log

history_file

History file

~/.cloudmonkey_history

...

A typical help doc for an api will list all available acceptable arguments and required arguments.

Tabular output

You may enable tabular listing and even choose set of column fields, this allows you to create your own field using the filter param which takes in comma separated argument. If argument has a space, put them under double quotes. The create table will have the same sequence of field filters provided. If your present cli does not have this, pl. upgrade cloudmonkey: pip install --upgrade cloudmonkey
To enable tabular output:

Code Block

> set tabularize true

Examples:

Code Block

> list domains listall=true
> list domains listall=true filter=id,name,path

Emacs style key handling

Ctrl+a (start of the line)
Ctrl+e (end of the line)
Ctlr+w (remove one word from back)
Ctrl+u (remove whole line) etc.

...