blueprintdata-cli
v1.0.2
Published
CLI tool to scaffold data stack projects
Maintainers
Readme
BlueprintData CLI
A CLI tool to scaffold data stack projects with pre-configured templates. Built with Bun for maximum performance, runs on Node.js for compatibility.
Installation
npm install -g blueprintdata-cliOr use directly with npx:
npx blueprintdata-cli newPrerequisites
- Node.js >= 18.0.0 (for running the CLI)
- Bun >= 1.0.0 (for development only)
Usage
Create a New Project
blueprintdata new [project-name]The CLI will prompt you for:
- Stack type (Lite Data Stack - BigQuery, Lite Data Stack - Postgres, AWS Data Stack)
- Project name
- Storage type (only if the stack supports multiple storages)
Options
blueprintdata new my-project --stack lite-bigquery
# or
blueprintdata new my-project --stack lite-postgres--stack <type>: Stack type (lite-bigquery, lite-postgres, aws;literemains an alias for lite-bigquery)--storage <type>: Storage type (postgres, bigquery) — only for stacks that allow a manual storage choice
Available Stacks
Lite Data Stack (BigQuery)
The Lite Data Stack (BigQuery) includes:
- Extraction: Meltano with tap-github + target-bigquery
- Transformation: dbt with BigQuery
- CI/CD: GitHub Actions workflows
- Storage: BigQuery
Lite Data Stack (Postgres)
The Lite Data Stack (Postgres) includes:
- Extraction: Meltano with tap-csv
- Transformation: dbt with Postgres
- CI/CD: GitHub Actions workflows
- Storage: PostgreSQL only (no storage prompt)
Project Structure
After creating a project, you'll get:
my-project/
├── extraction/ # Meltano project
│ ├── meltano.yml # Configuration
│ └── .venv/ # Virtual environment
├── transform/ # dbt project
│ ├── dbt_project.yml # Configuration
│ ├── profiles.yml # Database profiles
│ └── models/ # dbt models
└── .github/
└── workflows/ # CI/CDDevelopment
Setup
bun install
bun run build
npm linkTesting
bun test
bun run test:uiLinting
bun run lint
bun run formatType Checking
bun run typecheckContributing
- Fork repository
- Create your feature branch
- Commit your changes
- Push to branch
- Create a Pull Request
License
MIT
