@northslopetech/ns-cli
v0.9.0
Published
CLI tool for building Northslope projects
Keywords
Readme
@northslopetech/ns-cli
CLI tool for bootstrapping OSDK apps with Northslope best practices.
Usage
# Scaffold a new project
ns osdk create
# Configure GitHub Actions and production hosting
ns osdk setup-deploymentRunning ns osdk setup-deployment configures the GitHub repository with:
- Environment variables required for builds (
VITE_FOUNDRY_*) - The staging domain origin as
WEBSITE_BASE_URL, used by the PR preview workflow FOUNDRY_TOKENas a repository secret for deployments
GitHub Actions
Generated projects include two workflows:
Publish Frontend to Foundrypublishes tagged releases to production.Deploy PR Previewbuilds pull requests and deploys upload-only previews, posting a link based onWEBSITE_BASE_URL/.system/preview?previewVersion=<version>. It skips automatically until you runns osdk setup-deploymentto configure the required repository variables and secrets.
Requirements
- Node.js >= 18
- A Foundry account with Developer Console access
Development
Getting started (dev)
pnpm install
pnpm run dev -- createBuild & try as a package
pnpm run build && pnpm link
ns osdk createRun tests & linting / formatting
pnpm run test
pnpm run lint
pnpm run format