Foundation CLI

This is the command-line interface for Foundation for Apps. It downloads our template stack and installs the dependencies.

Requirements

You'll need the following software installed to get started.

• Node.js: Use the installer provided on the NodeJS website.
  • With Node installed, run [sudo] npm install -g gulp bower.
• Git: Use the installer for your OS.
  • Windows users can also try Git for Windows.

Installing

The Foundation CLI is installed through npm.

npm install -g foundation-cli

This will add the foundation-apps command to your system.

Updating

The CLI periodically gets updates that add features or fix bugs. Use npm to upgrade the CLI to the newest version.

npm update -g foundation-cli

To check what version you currently have, use -v.

foundation-apps -v

Commands

New

Downloads and installs a Foundation for Apps project, with the folder name you specify.

foundation-apps new appName

You can specify a particular version of the framework to use with the -v flag.

foundation-apps new appName -v 1.0.0

For the adventurous, you can check out the latest (and possibly unstable!) build of the framework with the --edge flag.

foundation-apps new appName --edge

Watch

While inside of your app's folder, use the watch command to assemble your app and run a test server.

cd appName
foundation-apps watch

While this process is running, you can view the assembled app in your browser, at this URL:

http://localhost:8080

While the server is running, any changes you make to your HTML, Sass, or JavaScript will automatically be processed and added to your live app.

Build

To build an app once, without running a server or watching for new changes, use the build command.

foundation-apps build

Update

Updates your Bower packages, which includes Foundation for Apps. Run this command when you want to update an existing project to the newest version of Foundation.

foundation-apps update

Docs

Opens the Foundation for Apps documentation.

foundation-apps docs

Help

Lists all available commands in the CLI.

foundation-apps help

Add a command name at the end to learn how a specific command works.

foundation-apps help new