actuated-cli

actuated-cli

Installation

Download the latest release from the releases page.

Then add the URL to either .bashrc or .zshrc:

export ACTUATED_URL=https://example.com

Or, run this command in a shell before executing any of the CLI commands.

View queued jobs

actuated-cli jobs \
    --token ~/reader.txt \
    --owner actuated-samples

View runners for organization

actuated-cli runners \
    --token ~/reader.txt \
    --owner actuated-samples

View SSH sessions available:

actuated-cli ssh \
    --token ~/reader.txt \
    ssh ls

| ACTOR | HOSTNAME | RX | TX | CONNECTED |
|-------|----------|----|----|-----------|

Connect to an SSH session

Connect to the first available session from your account:

actuated-cli ssh \
    --token ~/reader.txt \
    ssh connect

Connect to a specific session by hostname:

actuated-cli ssh \
    --token ~/reader.txt \
    ssh connect --host runner1

Check the logs of VMs

View the serial console and systemd output of the VMs launched on a specific server.

• Check for timeouts with GitHub's control-plane
• View output from the GitHub runner binary
• See boot-up messages
• Check for errors if the GitHub Runner binary is out of date

actuated-cli logs \
    --token ~/reader.txt \
    --host runner1 \
    --owner actuated-samples \
    --age 15m

The age is specified as a Go duration i.e. 60m or 24h.

You can also get the logs for a specific runner by using the --id flag.

actuated-cli logs \
    --token ~/reader.txt \
    --host runner1 \
    --owner actuated-samples \
    --id ea5c285282620927689d90af3cfa3be2d5e2d004

Check the logs of the actuated agent service

Show the logs of the actuated agent binary running on your server.

View VM launch times, etc.

actuated-cli agent-logs \
    --token ~/reader.txt \
    --host runner1 \
    --owner actuated-samples \
    --age 15m

Schedule a repair to re-queue jobs

If a job has been retried for 30 minutes, without a runner to take it, it'll be taken off the queue.

This command will re-queue all jobs that are in a "queued" state.

Run with sparingly because it will launch one VM per job queued.

actuated-cli repair \
    --token ~/reader.txt \
    --owner actuated-samples

Rescue a remote server

Restart the agent by sending a kill -9 signal:

actuated-cli restart \
    --token ~/reader.txt \
    --owner actuated-samples \
    --host runner1

Any inflight VMs will be killed, see also: actuated-cli update --force

Reboot the machine, if in an unrecoverable position:

actuated-cli restart \
    --token ~/reader.txt \
    --owner actuated-samples \
    --host runner1 \
    --reboot

Use with caution, since this may not perform a safe and clean shutdown.

JSON mode

Add --json to any command to get JSON output for scripting.

API rate limits apply, so do not run the CLI within a loop or watch command.

Staff mode

The --staff flag can be added to the runners, jobs and the repair commands by OpenFaaS Ltd staff to support actuated customers.

Help & support

Reach out to our team on Slack.