com.airconsole.cli v1.0.5

AirConsole CLI

AirConsole CLI is an UNOFFICIAL command line interface (npm) tool for AirConsole.com - the online video game console.

Use the command line interface to quickstart your game development, open the simulator, archive your game, ...

This tool was written by an engineer who works for AirConsole. However, it is more of a sideproject and thus no guarantees are made by the AirConsole / N-Dream company.

Installation

Execute this in your terminal:

  $ npm install -g airconsole-cli

Config file (Since version 1.0.3)

In your root directory of your project, create a file called airconsole.json

  // airconsole.json
  {
    // Id should be the same as the id you will use to submit your game on airconsole.com/developers
    "id": "com.your.game.id",

    // (Optional) If you want to specify a different localhost root url than the global one you set
    "localhost_root": "http://10.1.0.145:8887/other/",

    // (Optional) Overwrites the files you want to ignore in the archive command
    "ignore_files": ["*.zip", ".gitignore", "node_modules/**"]
  }

The values in the airconsole.json file will always overwrite the config values you may have set in the terminal earlier manually.

Commands

Help

Prints manual about airconsole-cli commands

  $ airconsole help

Create

Creates a directory with a sample (Javascript) AirConsole code.

 // Set the game-id
 $ airconsole create com.yourcompany.project

The game-id is also the directory name.

When you create a game on airconsole.com/developers you have to set a game-id. Use the same as the one you just provided.

Open

Opens the current dir in your browser as AirConsole game

 $ airconsole open

You will have to specify your localhost url and root dir (this will be global). E.g. http://192.168.0.12/workspace/

Params (Optional):

--ask will prompt you again for the localhost url in case you want to overwrite it OR use the airconsole.json config file.

Sim

Opens the current dir in the browser as AirConsole Simulator

 $ airconsole sim

Params (Optional):

--ask will prompt you again for the localhost url in case you want to overwrite it.

Info

Prints information about stored preferences etc.

  $ airconsole info

Doc

Opens the AirConsole developers documentation

 $ airconsole doc

Dev

Opens the AirConsole developers page with your game id

  $ airconsole dev

(Same as airconsole.com/developers?id=com.yourcompany.project

Params (Optional):

--ask will prompt you again to enter the game id

API

Prints or opens the AirConsole API

  $ airconsole api

  $ airconsole api web

Params (Optional):

web will open the API in your browser

Errors

Opens the AirConsole developers javascript errors page

  $ airconsole errors

Params (Optional):

--ask will prompt you again to set the game-id

Archive

Creates AirConsole .zip file with all files in current directory (excluding .-prepending files such as .git and node_modules)

  $ airconsole archive

  $ airconsole archive ./public my-changes

  $ airconsole archive . my-changes

If the directory contains git, then a fragment of the git-hash will be included to the output.zip

E.g. name-29E920.zip

Params (Optional):

directory_name Only the files in specific dir: airconsole archive public/

output_file_name Name of the output file: airconsole archive . filename

Ignore files

Use the airconsole.json config file to ignore to include files in the archive.

See the Config file section above.

Locally Set / Update game-id

If you are on version 1.0.3 or greater, then you can simply use the airconsole.json file to set an id.

Attention: this will NOT change your game-id on airconsole.com/developers.

Sets the game-id of this airconsole project.

  $ airconsole id com.yourcompany.project

It must be the same as the one you set on airconsole.com/developers!