@krakentech/blueprint-cli

@krakentech/blueprint-cli is a command-line tool that helps with various Blueprint-related tasks. It's built using zx, a tool for writing better scripts.

Installation

With zx

pnpm install -g zx

Then you can run commands like this:

pnpm blueprint [command]

See the Command list section below for available commands.

---

You can also use npx to run zx:

npx zx blueprint [command]

Without zx

You can also use the script directly, without the shortcut:

pnpm @krakentech/blueprint [command]

Command list

blueprint setup [options]

This command helps to link the current directory to a Vercel project and manage environment variables for different environments. It will:

1. Check if the Vercel CLI is installed
2. Link the directory to a Vercel project if not already linked
3. Pull environment variables for the specified environment

Options

• --env, -e <environment> - The environment to set up (production/prod, preview, development/dev)
• --vercel-project, --vp <project-name> - The Vercel project name to link to
• --file, -f <filename> - Specify the file where environment variables should be saved (default: '.env')
• --prod-url, -pu <URL> - Specify the production URL to add to the environment variables (default: 'localhost:3000')
• --ci - Run in CI mode without interactive prompts (default: false)
• --scope <scope-name> - The Vercel team or scope (default: "kraken-tech")
• --force - Force using Vercel Link even if already connected (default: true)
• --root, --r - Start from the Git repository root (default: false)
• --help, -h - Display help for the setup command

Examples

# Link project and pull production environment variables
blueprint setup --env=production --vp=my-project

# Link project and pull preview environment variables
blueprint setup --env=preview --vp=my-project

# Pull development environment variables (for already linked projects)
blueprint setup --env=development

blueprint help

Display help information about the blueprint CLI.