Commands

Overview of commands

Intro

Bit-Ship uses Podman as its core containerization technology. While we provide a polished, hands-off experience, direct access to Podman is sometimes useful. That's why we created the bitpod alias for direct Podman CLI interaction:

bitship {bitship_command} vs bitpod {podman_command}

We don't document Podman CLI you can refer to their official Podman Docs

Init

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

bitship init

Setup

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

bitship setup

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

bitship run my-task

Using namespace prefixes

bitship run job:myJob

Run all apps in parallel

bitship 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

Daemon

Daemon is a meta command to manage the daemon.

bitship daemon [sub-command]

Start

Starts the daemon

bitship daemon start

Restart

Restarts the daemon

bitship daemon restart

Stop

Stops the daemon.

bitship daemon stop

Logs

Preview logs of the previous runs

# preview logs of previous run
bit-ship logs

Settings

Configure your bit-ship CLI.

bitship settings

Help

Get help on bit-ship commands.

bitship help