npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

site-theme-cli

v1.0.0-alpha.2

Published

Site Theme CLI

Downloads

5

Readme

Code Coverage

| Statements | Branches | Functions | Lines | | --------------------------- | ----------------------- | ------------------------- | ----------------- | | Statements | Branches | Functions | Lines |

Usage

$ npm install -g site-theme-cli
$ site-theme-cli COMMAND
running command...
$ site-theme-cli (--version)
site-theme-cli/1.0.0-alpha.2 linux-x64 node-v18.17.0
$ site-theme-cli --help [COMMAND]
USAGE
  $ site-theme-cli COMMAND
...

Commands

site-theme-cli auth ACCESSTOKEN

Authorizes Square Online CLI with Access Token.

USAGE
  $ site-theme-cli auth ACCESSTOKEN [--verbose] [-f] [--skipPermissionsCheck]

ARGUMENTS
  ACCESSTOKEN  Square Connect Access Token

FLAGS
  -f, --force             Overwrite existing Access Token
  --skipPermissionsCheck  Skip the permissions check for Access Token. By default this will check to see that the token
                          has all the required permissions

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Authorizes Square Online CLI with Access Token.
  Visit https://developer.squareup.com/ for more information.

EXAMPLES
  $ site-theme-cli auth SQUARE_CONNECT_ACCESS_TOKEN

site-theme-cli help [COMMANDS]

Display help for site-theme-cli.

USAGE
  $ site-theme-cli help [COMMANDS] [-n]

ARGUMENTS
  COMMANDS  Command to show help for.

FLAGS
  -n, --nested-commands  Include all nested commands in the output.

DESCRIPTION
  Display help for site-theme-cli.

See code: @oclif/plugin-help

site-theme-cli theme install

Installs theme on a Square Online site.

USAGE
  $ site-theme-cli theme install [--verbose] [--siteId <value>]

FLAGS
  --siteId=<value>  ID of Square Online site on which you would like to install a theme, use to skip site selector step.

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Installs theme on a Square Online site.

EXAMPLES
  $ site-theme-cli theme install

site-theme-cli theme preview

Prints the development preview links for Square Online custom theme sites.

USAGE
  $ site-theme-cli theme preview [--verbose] [--siteId <value>]

FLAGS
  --siteId=<value>  ID of Square Online site to you would like to preview, use to skip site selector step.

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Prints the development preview links for Square Online custom theme sites.

EXAMPLES
  $ site-theme-cli theme preview

site-theme-cli theme pull

Clone Square Online Theme Files Locally

USAGE
  $ site-theme-cli theme pull [--verbose] [--siteId <value>] [--themeId <value>] [--accessToken <value>] [--yes]
    [--themeDir <value>]

FLAGS
  --accessToken=<value>  Use this flag to pass in an access token. If not passed the CLI will look for an access token
                         saved during "auth" command.
  --siteId=<value>       The Square Online site id that you would like to pull files from.
  --themeDir=<value>     Path to theme directory. If the directory does not exist it will be created.
  --themeId=<value>      The theme id that you would like to pull files from.
  --yes                  Use this flag to skip the confirmation prompts

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Clone Square Online Theme Files Locally

EXAMPLES
  $ site-theme-cli theme pull

site-theme-cli theme push

Push your local theme files to your Square Online site. Files with the following patterns will be ignored by default: /_darcs/,/CVS/,/config.yml/,/node_modules/,/.git/,/.DS_Store/,/.soignore/,/.dockerignore/,/.gitmodules/, as well as any patterns within the /.soignore file

USAGE
  $ site-theme-cli theme push [--verbose] [--themeDir <value>] [--siteId <value>] [--themeId <value>]
    [--omitDelete] [--accessToken <value>] [--yes]

FLAGS
  --accessToken=<value>  Use this flag to pass in an access token. If not passed the CLI will look for an access token
                         saved during "auth" command.
  --omitDelete           If set the CLI will skip any delete operations during syncing
  --siteId=<value>       The Square Online site id that you would like to push files to.
  --themeDir=<value>     Path to theme directory.
  --themeId=<value>      The theme id that you would like to push files to.
  --yes                  Use this flag to skip the confirmation prompts

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Push your local theme files to your Square Online site. Files with the following patterns will be ignored by default:
  /_darcs/,/CVS/,/config.yml/,/node_modules/,/.git/,/.DS_Store/,/.soignore/,/.dockerignore/,/.gitmodules/, as well as
  any patterns within the /.soignore file

EXAMPLES
  $ site-theme-cli theme push

site-theme-cli theme watch

Watch your theme directory and automatically upload file changes to Square Online. Files with the following patterns will be ignored by default: /_darcs/,/CVS/,/config.yml/,/node_modules/,/.git/,/.DS_Store/,/.soignore/,/.dockerignore/,/.gitmodules/ as well as any patterns within the /.soignore file

USAGE
  $ site-theme-cli theme watch [--verbose] [--themeDir <value>] [--siteId <value>] [--themeId <value>]
    [--hotReload] [--omitDelete] [--autoPush]

FLAGS
  --autoPush          Automatically push local changes when theme directory is out of sync
  --hotReload         Set this flag to print the preview links and enable hot reloading
  --omitDelete        If set the CLI will skip any delete operations during syncing
  --siteId=<value>    The id of the Square Online site you would like to sync to.
  --themeDir=<value>  Path to theme directory for watching.
  --themeId=<value>   The theme you would like to sync files to.

GLOBAL FLAGS
  --verbose  Print all API logs in console.

DESCRIPTION
  Watch your theme directory and automatically upload file changes to Square Online. Files with the following patterns
  will be ignored by default:
  /_darcs/,/CVS/,/config.yml/,/node_modules/,/.git/,/.DS_Store/,/.soignore/,/.dockerignore/,/.gitmodules/ as well as any
  patterns within the /.soignore file

EXAMPLES
  $ site-theme-cli theme watch

CI/CD Usage

The theme pull and theme push commands support automated workflows. Passing in an accessToken flag will skip using any on saved through the auth command. themeDir flags can be either relative or absolute. yes will skip any steps that usually require a user confirmation to continue.

site-theme-cli theme pull --siteId=site_693636287506607541 --themeId=site_theme_63ab1ab0-59e1-11ef-8cee-23c1d5cbb712 --themeDir=./brisk-theme --accessToken=YOUR_ACCESS_TOKEN --yes
site-theme-cli theme push --siteId=site_693636287506607541 --themeId=site_theme_63ab1ab0-59e1-11ef-8cee-23c1d5cbb712 --themeDir=./brisk-theme --accessToken=YOUR_ACCESS_TOKEN --yes

Getting Started

  1. Install Node.
  2. Install NVM.
  3. nvm use
  4. npm ci