Skip to main content

Shipit CLI is the best way to build, serve and deploy your projects anywhere.

Project description

Shipit

Shipit is a CLI that automatically detects the type of project you are trying to run, builds it and runs it using Starlark definition files (called Shipit).

It can run builds locally, inside Docker, or through Wasmer, and bundles a one-command experience for common frameworks.

Quick Start

To use shipit, you'll need to have uv installed.

Install nothing globally; use uvx shipit-cli to run Shipit from anywhere.

uvx shipit-cli .

Running in auto mode will generate the Shipit file when needed, build the project, and can also serve it. Shipit picks the safest builder automatically and falls back to Docker or Wasmer when requested:

  • uvx shipit-cli . --wasmer builds locally and serves inside Wasmer.
  • uvx shipit-cli . --docker builds it with Docker (you can customize the docker client as well, eg: --docker-client depot).
  • uvx shipit-cli . --start launches the app after building.

You can combine them as needed:

uvx shipit-cli . --start --wasmer --skip-prepare

Commands

Default auto mode

Full pipeline in one command. Combine flags such as --regenerate to rewrite the Shipit file. Use --wasmer to run with Wasmer, or --wasmer-deploy to deploy to Wasmer Edge.

generate

uvx shipit-cli generate .

Create or refresh the Shipit file. Override build and run commands with --install-command, --build-command, or --start-command. Pick a exlicit provider with --use-provider.

plan

uvx shipit-cli plan --out plan.json

Evaluate the project and emit config, derived commands, and required services without building. Helpful for CI checks or debugging configuration.

build

uvx shipit-cli build

Run the build steps defined in Shipit. Append --wasmer to execute inside Wasmer, --docker to use Docker builds.

serve

uvx shipit-cli serve

Execute the start command for the project. Combine with --wasmer for WebAssembly execution, or --wasmer-deploy to deploy to Wasmer Edge.

Supported Technologies

Shipit works with three execution environments:

  • Local builder for fast, host-native builds.
  • Docker builder when container isolation is required.
  • Wasmer runner for portable WebAssembly packaging and deployment.

Development

Clone the repository and use the uv project environment.

uv run shipit . --start

Use any other subcommand during development by prefixing with uv run shipit, for example uv run shipit build . --wasmer. This keeps changes local while matching the published CLI behaviour.

Tests

Run the test suite with:

uv run pytest

You can run the e2e tests in parallel (-n 8) with:

uv run pytest -m e2e -v "tests/test_e2e.py" -s -n 8

The e2e tests will:

  • Build the project (locally, or with docker)
  • Run the project (locally or with Wasmer)
  • Test that the project output (via http requests) is the correct one

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipit_cli-0.17.3.tar.gz (42.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipit_cli-0.17.3-py3-none-any.whl (53.4 kB view details)

Uploaded Python 3

File details

Details for the file shipit_cli-0.17.3.tar.gz.

File metadata

  • Download URL: shipit_cli-0.17.3.tar.gz
  • Upload date:
  • Size: 42.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.7.13

File hashes

Hashes for shipit_cli-0.17.3.tar.gz
Algorithm Hash digest
SHA256 2984cb19cb2976928e8f49d2cfc09f86411757be640e6245902fdd357bc163a7
MD5 8a5a6ce4f711c150fe6de815105c2476
BLAKE2b-256 999231c2079af7991e30e8ef9a64a4ff9f469891606de883ae55eb56a146d282

See more details on using hashes here.

File details

Details for the file shipit_cli-0.17.3-py3-none-any.whl.

File metadata

File hashes

Hashes for shipit_cli-0.17.3-py3-none-any.whl
Algorithm Hash digest
SHA256 b400692119015ebe42445c02925bacc3eb78b9f5f8c0093186ec1dac6015ac34
MD5 5f288e8900be3ce33be460c87deac5f1
BLAKE2b-256 ceb8a2367d3e09ced5a969505717edf38715cb3d45babd56d0fa7b08fd971baa

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page