sitepack-cli
v1.0.0
Published
<img src="https://github.com/sitepack-io/sitepack-cli/blob/main/assets/sitepack-cli-256x256.webp?raw=true" alt="SitePack cli" width="128"/>
Downloads
9
Readme
SitePack CLI
With the SitePack command line interface (SitePack CLI), you can:
- initialize, build, and manage SitePack themes
- bootstrap, develop, and manage SitePack apps
- build and manage your ecosystem
Learn more in the docs: sitepack.dev
Installation
Install the SitePack CLI globally using npm:
npm install -g sitepack-cliOr using yarn:
yarn global add sitepack-cliOr run it directly using npx:
npx sitepack-cliOr using yarn dlx:
yarn dlx sitepack-cliAuthentication
Before you can use most features of the SitePack CLI, you need to authenticate your account.
To log in, run:
sitepack loginFollow the link displayed in your terminal to authorize the CLI in your browser.
To check your current authentication status, run:
sitepack whoamiGetting Started
Initialize a new theme
To start a new SitePack theme project, run:
sitepack theme:initFollow the prompts to name your theme and initialize a Git repository.
Develop your theme
To watch for changes in the theme directory and sync to SitePack, navigate to your theme directory and run:
sitepack theme:watchBootstrap a new app
To bootstrap a new SitePack app, run:
sitepack app:initThis will create a new app structure and a package.json file.
Develop your app
To run your app in development mode, navigate to your app directory and run:
sitepack app:devCommands
| Command | Description |
| --- | --- |
| sitepack login | Connect the CLI interface with your SitePack account |
| sitepack whoami | Show the currently logged in user |
| sitepack app:dev | Run your app in development mode |
| sitepack app:init | Bootstrap a new SitePack app project |
| sitepack theme:init | Start a new SitePack theme project |
| sitepack theme:watch | Watch for changes in the theme directory and sync to SitePack |
| sitepack --version | Check the current version of the CLI |
| sitepack --help | Show help for all commands |
For more detailed information, visit sitepack.dev.
