Box CI

Quick Start Guide

Box CI setup is simple. Get a build running in 5 minutes with the steps below.


Create a Project

Start by signing up for a free account and creating a project from the dashboard.


Install the Box CI Agent

Install the agent as a global npm package.

> npm i -g boxci

Confirm the installation by running boxci --version, which should print the version you just installed.

The full documentation on the agent is here.


Run an agent for your project

> boxci agent --project PXXXXXX --key xxxxxxxx

--project is your project's ID, --key is its secret key. Both are available on the project page - get there by selecting the project from the dashboard.

You should see that the agent connects to Box CI and starts listening for builds for your project.


Run a build

To run a build you just need to add a config file named boxci.yaml or boxci.json, depending on your preferred format, in the root directory of your source code.

In this config file you specify your build pipelines - series of commands to run on different branch/tag patterns. Full documentation here.

To get a build running, let's start with a simple "hello world" build config.

copy code
tasks: build: printf 'hello world' pipelines: *: ['build']

This configures a pipeline that runs when you push any branch/tag. The pipeline contains a single task that prints "hello world".

To run the build, just commit the config file and push. You'll see your agent run the build. Follow the link to the build in the agent's output. You'll see the build has succeeded and logged out "hello world".

What next?

Now the setup is done, you have everything in place to run your project's build. All you need to do is add your actual build pipelines to your config.

See the full documentation on build configuration here.

Quick startDocsBlog