EspressoAdminCLI
Description
This is a command-line tool to administer Espresso Logic servers. It allows the creation, modification and deletion of many common objects, such as projects, database connection, resources and rules. Once you have your server running (cloud or on-premise) you will create one or more projects. Each project can have one or more database connections which will create instant REST API endpponts for tables, views, and stored procedures. Resources are used to create new custom endpoints (e.g. nested documents) and can be based on tables, JavaScript, MongoDB, or custom SQL. Logic is applied as derivations on columns attributes, validations, and events on transactions. Security and authentication is added to secure your REST endpoints.
Installation
npm install espresso-admin-cli
Please note that, on Windows (and sometimes Mac), npm install will create an executable
called espressoadmin in your
<node_modules>/.bin directory. If this directory is not in your PATH, you will probably
want to fix that, otherwise you'll have to specify the full path to the executable. You can also try
npm install -g espresso-admin-cli
Login
espressoadmin login <url> -u <user-name> -p <password> [-a <alias>]
Parameters
The URL will normally be the address of the server, such as:
https://eval.espressologic.com
http://api.acme.com
If you specify an alias, then you will be able to refer to that connection using that alias. This is useful if you plan to work with several servers at the same time.
Regardless, this command sets your current server -- see the use command below.
Example
$ espressoadmin login https://api.acme.com -u fred -p secret
Logging in...
This server licensed to: Acme Inc.
Login successful, API key will expire on: 2014-11-27T03:36:55.266Z
Command Line Service
$ espressoadmin --help
Usage: espressoadmin [options] [command]
Commands:
login [options] <url> Login to an Espresso Logic server
logout [options] [url] Logout from the current server, or a specific server
use <alias> Use the specified server by default
status Show the current server, and any defined server aliases
project [options] <list|create|update|delete|use|import|export> Administer projects. Actions are: list, create, update, delete, use, export
database [options] <list|create|update|delete> Administer databases within a project.
resource [options] <list> Administer resources within a project.
rule [options] <list|create|delete> Administer rules within a project.
authprovider <list> Administer authentication providers for an account.
Options:
-h, --help output usage information
-V, --version output the version number
Logout
espressoadmin logout [-a <alias>]
This will log you out of the current server, unless you specify an alias, in which case you will be logged out of that server.
Use
espressoadmin use <alias>
This switches the current server to the specified alias.
Status
espressoadmin status
Prints which server is the current server (if any) and project, and what aliases are defined (if any).
Output
Defined aliases:
┌───────┬───────────────────────────────────────────────────────┬───────┐
│ Alias │ Server │ User │
├───────┼───────────────────────────────────────────────────────┼───────┤
│ api │ http://api.acme.com/rest/abl/admin/v2 │ admin │
└───────┴───────────────────────────────────────────────────────┴───────┘
You are currently logged in to admin server: http://acme.my.espressologic.com/rest/abl/admin/v2 as user acme
Current project is: Acme Sales [1234] - url_name: sales
Object-specific commands
Follow the links below for detailed documentation on specific administrator commands.