boxci

Box CI Agent

The Box CI agent is the open source tool you install on your build machines to run builds.

It does all the work of coordinating with the Box CI Service - all you have to do is run it.

It's open source, so you know exactly what is running on your machine.

---

Install

> npm i -g boxci

This installs the Agent CLI globally as boxci on your build machine. Confirm the installation by running boxci --version.

The Agent CLI requires NodeJS v12+ on your build machine to install and run. This is to support as many platforms as possible, as seamlessly as possible.

---

Usage

The Agent CLI has commands for starting/stopping agents, and managing local build history and logs on the machine.

• boxci agent
• boxci stop
• boxci history
• boxci logs
• boxci clean-logs
• boxci --version
• boxci --help

For more detail & examples see https://boxci.dev/docs/agent

---

boxci agent

Run an agent for a project.

Specify the project ID and secret key with the --project and --key options.

Each agent can run one build at a time for the specified project. You can run as many agents as you want on a single machine or across different machines.

Options
  Required
    --project    -p   Project ID
    --key        -k   Project secret key
  Optional
    --machine    -m   Build machine name
    --silent     -s   No console output
    --ssh-host   -h   Use this host for ssh requests

---

boxci stop <agent>

Gracefully stop a running agent.

Arguments
  Required
    agent              Name of the agent

---

boxci history

View history of agents and builds run on this machine.

Arguments
  Optional
    mode               One of the following 3 values:

                       'builds'     list history of all
                                    builds
                       'projects'   list history of builds
                                    grouped by project
                       'agents'     list history of builds
                                    grouped by agent

                       - OR -

                       leave blank to show an overview of
                       the numbers of builds, projects and
                       agents in the history

---

boxci logs <build>

Print the absolute path to the local log file for a build.

Arguments
  Required
    build              ID of the build

---

boxci clean-logs

Clean logs of builds on this machine.

Options
  One Required
    --build       -b   A build ID
                       Clear logs for this build
    --project     -p   A Project ID
                       Clear logs of all builds for this
                       project
    --all         -a   Clear logs of all builds

---

boxci --version

Show the currently installed version.

---

boxci --help

Show documentation.

---

For more detail & examples see https://boxci.dev/docs/agent