Command-Line Interface

Node.ACS provides a simple command-line interface, acs, for creating and administering Node.ACS applications.

acs requires Node.js version 0.8.13 or greater. If you don't have a suitable version of Node installed, please visit: http://nodejs.org to install or upgrade Node.

Once Node is installed, run the following command to install acs.

npm install -g acs

Depending on how Node is installed, you may need to run the install command as an administrator:

sudo npm install -g acs

CLI Commands

acs provides commands for you to create and manage Node.ACS applications. Command usage has the following format:

acs [_COMMAND_] [_COMMON OPTIONS_] [_COMMAND OPTIONS_]

Running acs --help will give you a full list of commands usage, you can also run acs _COMMAND_ --help to get the usage of a specific command.

Here is a list of available commands and brief description for each of them:

Name Description
accesslog List application's access log
add Add a new route/service
cname Set a CNAME for an application
config Configures the application
crt Manages SSL certificates for the application
download Downloads source files for the specified application and version.
list List all applications
logcat Tail active application logs
loglist List application logs
login Login to Node.ACS
logout Log out of Node.ACS
new Create new application
publish Publish application to Node.ACS cloud
remove Remove an application
run Run an application locally for dev./testing
unpublish Unpublish an application
whoami Show current login user

Common CLI Options

Name Description
-h, --help Show command usage information.
-v, --version Show CLI version.
-d, --dir dir Specifies an application by its directory.
-n, --no-colors Turn off coloring for command output.
--no-banner Turn off banner for command output.
--dates Turn on dates in log.

Login with Appcelerator Credentials

Most ACS commands require that you have a valid login session to execute them (add and run are the exceptions). Use the login command to login at anytime.

If you don't have a current session when running a command that requires it, the CLI will prompt you to login and, if successful, run the requested command. For instance, in the following example the acs publish command was executed without a current login session, so the user is prompted to login.

$ acs publish
ACS: Appcelerator Cloud Services Command-Line Interface, version 1.0.16
Copyright (c) 2012-2014, Appcelerator, Inc.  All Rights Reserved.

Login required!
host (https://admin.cloudapp.appcelerator.com): <enter for default>
username: nobody@appcelerator.com
password: ********  
Welcome back, Nobody! You are now logged in.
Preparing application for publish... \