Skip to content

skippr init

Create a new project. This is always the first step -- it sets up the config file and tells you exactly what to do next.

Usage

bash
skippr init <project-name>
skippr init <project-name> --reset

What it creates

  • skippr.yaml -- your project config (warehouse, source, and pipeline settings all live here).
  • .env.example -- lists the environment variables you'll need.
  • .skippr/ -- the local runtime directory for generated state, logs, and artifacts.

Reset an existing project

Use --reset when you want to fully re-initialise a project and clear previous run state:

bash
skippr init mssql-migration --reset

--reset will:

  • Delete the local .skippr/ directory (offsets, metadata, buffers).
  • Delete remote project metadata and state from the authenticated project's S3 scope.
  • Prompt for confirmation by requiring you to type yes.
  • Recreate the local .skippr/ environment scaffold.

Your skippr.yaml config file is preserved so you don't lose warehouse and source connection settings.

Arguments

ArgumentRequiredDescription
project-nameYesProject identifier. Used as the pipeline name and dbt schema prefix (e.g. my_project_silver).

Example

bash
mkdir my-workspace && cd my-workspace
skippr init mssql-migration

Output:

Initialised project 'mssql-migration' in /Users/me/my-workspace

Next steps:
  skippr connect warehouse snowflake
  skippr connect source mssql
  skippr doctor
  skippr run

Notes

  • Running init in a directory that already has skippr.yaml is idempotent. It will print that the project is already initialised and leave the existing files alone.
  • Use skippr init <project-name> --reset if you want to wipe local and remote state and start again from a clean project.
  • The project name should be a valid identifier (letters, numbers, underscores). It's used to name your warehouse schemas.