Square Online CLI Reference

Command line interface that lets you manage site files locally.

The Square Online CLI is in the ecom-square-online-cli-master.zip file that was provided to you by the Square team. Full documentation can be found in the README.md file.

You can use the CLI to initialize a theme on a new site in a multi-site account and then push and pull changes from from your local development environment. It can also synchronize your local changes back to the site automatically so you can quickly preview the output.

See the Get Started tutorial for steps that show how to set up and use the CLI.

Permissions

The following OAuth permissions are required to run CLI commands, which are wrapper commands for the Sites API. For more information, see Manage Access to the Square APIs.

Permission	Description
MERCHANT_PROFILE_READ	Required by all Square API endpoints.
ONLINE_STORE_SITE_READ	Required by the ListSites endpoint.
ONLINE_STORE_CUSTOM_THEME_WRITE	Required by endpoints that perform a POST, PUT, or DELETE operation on a custom site.
ONLINE_STORE_CUSTOM_THEME_READ	Required by endpoints that perform a GET operation on a custom site.