API Runtime Services Command-Line Interface Reference

Introduction

API Runtime Services uses the Appcelerator Cloud Services command-line interface, called acs for short, for creating and administering applications in the API Runtime Services environment. By default, the Appcelerator CLI or Studio handles the installation of the acs CLI tool.

Setup

The Appcelerator CLI or Studio manages the installation of the acs CLI. To run acs subcommands, use the appc cloud subcommand.

To manually install the acs CLI, independent of the other tools:

1. Download and install Node.js from http://nodejs.org/#download, which includes the npm package manager needed to install the acs CLI.

2. From a console window, run the following command to install the CLI: 

3. Login to API Runtime Services. 

Most commands require you to be logged in.  If you do not run commands in the project's directory, in most commands, you need to either specify the app name as the last parameter or specify the project's location with the -d parameter.

acs commands

accesslog

List application's access logs within a specified period. By default, a maximum of 100 log messages will be returned at a time.

Dates are specified as YYYY-MM-DD or "YYYY-MM-DD HH:MM". Note that if the time is included, the date string must be quoted. If the specified date range contains more than specified maximum number of logs, the most recent messages will be returned.

add

Adds a new route or service to an existing application. The name parameter specifies the new the route's name, as well as the name of the handler function.

autoshutdown

Automatically deactivate non-development containers after the specified number of seconds.

config

The  config  command configures environment variables and the number of cloud servers for the application to use (auto-scaling).

crt

Manages custom SSL certificates for accessing your application via HTTPS.

domain

Binds a domain to a published application, so that the application can be accessed using a custom domain as an alias for the application's cloud.appcelerator.com URL.

list

Shows a list of applications owned by the current user. By default, data is listed for all applications. You can specify an application name to only show details for that application. The information returned by this command also includes error messages, if any, related to the application's deployment and execution.

logcat

Retrieves and displays a published application's runtime logs continuously from API Runtime Services. It lets you see in real-time what's happening with an application running in the cloud. By default, runtime logs are retrieved every five seconds, and you can configure this interval with the  --interval  parameter. The interval cannot be smaller than five seconds.

login

Command for logging in to API Runtime Services using your AMPLIFY Appcelerator Services account credentials.

loglist

Lists the application's log within a specific period. By default, a maximum of 100 log messages is returned at a time. 

Dates are specified as YYYY-MM-DD or "YYYY-MM-DD HH:MM". Note that if the time is included, the date string must be quoted. If the specified date range contains more than specified maximum number of logs, the most recent messages will be returned.

logout

Logout from API Runtime Services.

new

Starting with API Runtime Services (Arrow Cloud) 1.6.0, acs new creates a sample Node.js, app and acs new --image creates a sample app with Dockerfile.

publish

Publishes and runs an application on the API Runtime Services. This command also lists all currently published versions and the currently deployed version.

Note that if an application is not listening on port 80, use acs config --set PORT=customport to make publish work. Also, note that publishing an application now supports publishing Docker images directly.

For a newly installed on-premise cluster, if the Domain Name System (DNS) is not configured for the Mobile Backend Services endpoint, use acs config --set "extra_hosts=<ip> api.<domain> <appname>" before or after publish for your app to reference to the Mobile Backend Services endpoint that is not in the database. This applies to all endpoints that don't exist in the DNS yet and extra_hosts can take a list of entries. such as 

acs config --set "extra_hosts=54.219.6.230 www.163.com;54.219.6.230 www.123.com" <appname>

For appc publish, you can include it in appc.json:

"environment": {"extra_hosts":"54.212.208.81 api.cloudapp-1.appctest.com"},

remove

Removes an application. If the application has been published, the command unpublishes the application first, then removes it.  The local application directory is not deleted by default. Use the --force option to delete it.

restart

Released with Appcelerator CLI 6.0.0, this command allows you to restart an API Runtime Services application without having to use acs publish --force

Note: This command will restart all servers associated with your app.

run

Start an API Runtime Services application locally for development and testing purposes.

server

The server command configures the server container size of the application. If your application is already published after changing the container size, you will need to republish the application.

unpublish

By default, unpublishes the currently deployed and active application, shutting the application down and deleting it from the API Runtime Services cloud. You can also unpublish a specific version with the  --ver  option, regardless of whether it is deployed or not. The local application directory is not removed after an unpublish operation, so you can republish the application again with the publish command.

usage

Check server system resource usage within a specific period. The server in cloud logs CPU/memory usage periodically. By default, a maximum of 100 log entries will be returned at a time.

whoami

Shows the currently logged-in user and organizations you belong to.