Cli

Commands

Overview of commands

Init

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

bit-ship init

Image

Image is meta command to manage images

bit-ship image [sub-command]

Create

Create a new image from scratch.

bit-ship image create

Run

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

To avoid name conflicts, you can use namespace prefixes appsjobstasks. 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
OptionDescription
--detachRun 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
OptionDescription
--imageWhich image should run

Stop

Stop running app, job or task.

# Stop specific app
bit-ship stop [app]

Demon

Demon is a meta command to manage the demon.

bit-ship demon [sub-command]

Start

Starts the demon

bit-ship demon start

Restart

Restarts the demon

bit-ship demon restart

Stop

Stops the demon.

bit-ship demon 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