Commands

Overview of commands

Init

Analyses your project and creates initial bit-ship.yml file.

bit-ship init

Setup

Complete setup of Bit-Ship environment. This command initializes the Podman machine and starts the Bit-Ship daemon in one step.

bit-ship setup

This is equivalent to running:

bit-ship machine init
bit-ship daemon start

Image

Image is meta command to manage images

bit-ship image [sub-command]

Create

Create a new image from scratch.

bit-ship image create

Build

Build image from local dockerfile

bit-ship image build {name}

Run

Run tasks, jobs and apps defined in the bit-ship.yml file.

To avoid name conflicts, you can use namespace prefixes `apps` `jobs` `tasks`. Don't use these prefixes as names of your apps, jobs or tasks.

Basic use case

bit-ship run my-task

Using namespace prefixes

bit-ship run job:myJob

Run all apps in parallel

bit-ship run apps

Option	Description
`--detach`	Run task in background

Exec

Execute any script in you environment

# Run specific script
bit-ship exec [script]
# or
# Enter the shell of the container
bit-ship exec

Option	Description
`--image`	Which image should run

Machine

Configure the Podman virtual machine that Bit-Ship runs on. This command passes all arguments directly to podman machine, allowing you to manage the virtual machine configuration.

bit-ship machine [podman-machine-args]

Common examples:

# Initialize a new machine
bit-ship machine init

# Start the machine
bit-ship machine start

# Stop the machine
bit-ship machine stop

# Check machine status
bit-ship machine info

# List all machines
bit-ship machine list

This command supports all podman machine subcommands and options. Run `podman machine --help` for full documentation.

Daemon

Daemon is a meta command to manage the daemon.

bit-ship daemon [sub-command]

Start

Starts the daemon

bit-ship daemon start

Restart

Restarts the daemon

bit-ship daemon restart

Stop

Stops the daemon.

bit-ship daemon stop

Logs

Preview logs of the previous runs

# preview logs of previous run
bit-ship logs

Settings

Configure your bit-ship CLI.

bit-ship settings

Help

Get help on bit-ship commands.

bit-ship help