Skip to content
Changelog

Automation

postship, the full-screen CLI

A full-screen keyboard interface, sign-in through the browser, and “Clear to ship?” before every ship.

The postship command was born for one thing: checking a preview from continuous integration. It has become the place to follow your projects without opening a browser — a real terminal application, built for the moment that matters, right before and right after a git push.

The terminal open on postship: projects on the left, details on the right, and the “Clear to ship” line.

A window of its own

Typed on its own, postship opens a full-screen interface: your projects on the left, sorted so those with an incident come first; the details on the right, in tabs — Overview, Incidents, Deployments, URLs. Everything is keyboard-driven: arrows to choose, / for the command palette, ? for help, q to quit. The screen refreshes every 30 seconds and tells you when an incident opens or closes.

On first launch, three questions: how to sign in, which project to open by default, and whether you want desktop notifications.

“Clear to ship?”

At the top of a project's details, one line answers the question you ask before pushing: clear to ship, or ship blocked — by an open incident, a Ship Score below your floor, or a last deploy not yet concluded. And when a deploy has just been checked, the interface says so, with its score.

Sign in without copying a key

postship login shows a code in the terminal and opens a page on postship.fr. You check it is the same code, click “Authorize”, and the key reaches the machine without passing before your eyes. Each terminal appears in Workspace settings → API, and its key expires after 90 days without use. A hand-pasted API key still works, for machines without a browser.

In CI and every day

  • postship wait --head --notify waits until the commit you just pushed is checked in production, then tells you.
  • postship watch follows the incidents of all your projects live.
  • postship check checks a URL or a preview, and fails if it breaks: enough to stop a pipeline.
  • The GitHub action titilyonnais/postship-check@v1 does the same in a workflow, with the token kept in the environment.
  • postship update updates the CLI, postship uninstall removes it cleanly.
Read the documentation