saasquatch-cli
A command line interface to the Referral SaaSquatch API.
Installing
Install via npm (requires node.js).
$ npm install -g saasquatch-cliUsage
The tool can be accessed with the squatch command on the command line:
$ squatch --helpsquatch publish
Publish a custom theme. Uses the HEAD of the configured repository.
$ squatch publish -t test_alu125hh1si9w -k TEST_BHASKh5125Las5hL125oh3VbLmPxUSsOptions
-t, --tenant [tenant] required - which tenant to use
-k, --apiKey [apiKey] required - which API key to use (for corresponding tenant)
squatch serve
❗️ alpha
Start local static and API servers, with Handlebars and LESS compilation and LiveReload.
$ squatch serve[10:28:54] Server started http://0.0.0.0:8080[10:28:54] LiveReload started on port 35729API listening at http://0.0.0.0:8090Configuring the API Server
Create an api.json in your theme directory with request / response pairs (exchanges) defined. Also add the apiEndpoint key to your customer.json.
Why is this alpha?
The serve command uses Handlebars.js, contrasting with the Handlebars.java library used in Referral SaaSquatch.
This means that the serve command will allow you to do things that Handlebars.js supports, but that are not supported in Handlebars.java.
Please see the Handlebars.java documentation for an overview of the supported features.
For an example of a theme written to support Handlebars.java, please see our Time Credit Theme.
License
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this work except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.