Skip to content
Esc
  • Type what you're looking for in your own words: “Slack”, “503”, “price”.

postship init

Write ./.postship.json: the project and the threshold. Never the key.

Updated on 17 September 2026

On this page

In a terminal, lists your projects and lets you pick with the keyboard; otherwise takes --project. Writes ./.postship.json — committable — with the project and the threshold (80 by default). The key stays in POSTSHIP_TOKEN or ~/.config/postship: never in a versioned file.

This command does not consume the quota: it is a read.

What PostShip does

Usage

postship init [--project <id>] [--min-score <n>]

Options

OptionWhat it does
--project <id>The project, skipping the list.
--min-score <n>The threshold to write (80).

Examples

postship init

Pick from the list, arrows and Enter.

postship init --project 3f1c… --min-score 90

No question asked, for a script.

Exit codes

0 file written · 2 no terminal and no --project, invalid id, token, network.

See also

The postship command — every command, installation and sign-in · CI recipes — complete workflows to copy.

In the terminal, postship help init says the same; postship docs init opens this page.

postship init — Docs — PostShip