SaaSBox
Search…
Commandline Interface
Edit your templates locally and push to your app.
SaaSBox CLI lets you check out a template via git, and edit your templates locally, then push your template to your SaaS and make it live.
The benefit of this approach is that you can maintain different versions of your template as a development project, and have the convenience of using a dev studio or editor to edit your pages.
Pushing your changes to your SaaS re-creates the same template in the application, pushing your template description, Pug files and static assets.

Getting Started

Installing the CLI:
1
npm install saasbox-cli
Copied!
Checking out the default free template:
1
git clone https://github.com/getsaasbox/default-free-atis-tailwind.git
Copied!
If you have a Tailwind UI bundle license, check out command:
1
git clone https://github.com/getsaasbox/default-template.git
Copied!
Adding your API Keys:
Go to "Inbound API Keys" section of your SaaS dashboard. Click on "Generate API Key"
Inbound API keys are used for making any request into SaaSBox, such as pushing a template.
Create a new file in your home directory called .sbox-config . Then copy paste your API key and Application ID as follows:
1
{
2
"apikey": "e6125403603450f0c8701a34ddf14ae66e6",
3
"appid": "42652a13-66a3-4dd3-960e-243dc0160ee6"
4
}
Copied!
This file will be read by the sbox cli and used for API credentials.
Edit your frontend files and push from inside your template directory:
1
sbox -d -a .
Copied!
Here, "." represents current directory, and -d means deploy. Deploy will deploy the template, however it will not make it go "live". If you want to both deploy and make your template live, a "-a" or "--active" option needed as well.

Next Steps

Congratulations! You have edited and pushed your SaaS template, and the template is maintained on your local computer. It is highly recommended to create a git repo and track versions of your SaaS template.
Last modified 1mo ago
Copy link