Five Things Not to Do When Building Your SaaS CLI
tutorials, saas, cli
Table of Contents
- 1. Implement your own CLI tooling (or doc system)
- 2. Neglect your testing environment
- a. The simple approach
- b. Slightly-more-mature
- c. Tactically coherent
- d. Fully integrated
- 3. Ignore semver/release notes
- 4. Inconsistent verbs, parameters, or configuration components
- 5. Build your CLI to reflect your API, instead of your user/automation tasks
- (Bonus!) 6. Forget about authorization mechanisms and integrations
- Before you go...
Congratulations! Your infrastructure SaaS application has become sufficiently popular that people are now trying to use it for real instead of the little toy projects they’d been doing before. After several requests, you realize that everyone has to create these Frankensteinian horrors of shell scripts, curl, and god-knows-what to perform some pretty basic tasks in automation, and it’s really slowing down interest and adoption.
You decide to make a command line tool for your SaaS. Great! Here’s a list of things not to do!
1. Implement your own CLI tooling (or doc system)
Don’t implement your own CLI commands from scratch. Anything to do with the terminal, parsing the command line, dealing with ncurses and terminal compatibility issues, and then trying to make all of that work cross-platform… no way!
Bonus: all of these support
help or other kind of doc system. You can also add
man pages, especially with examples, for the more complicated tools!
2. Neglect your testing environment
You’ve decided to lean hard on React and have chosen Ink to build your command line interface. Now, don’t just create it and throw it over the wall - add test cases and test coverage as well!
Let’s look at a variety of approaches you can use.
a. The simple approach
The simplest approach is to use a bunch of shell scripts surrounding your CLI and the expect or autoexpect tools to issue a command and then
expect a specific response in the output. Simple, straightforward, and very fast to do some quick-and-dirty validation tests.
Generally, though, expect-based tests tend not to scale well, are moderately fragile, and require substantial shell-code experience to get right.
As a slight step up from
Still not generally recommended, except in very limited end-to-end test scenarios.
c. Tactically coherent
As a more sophisticated approach to leveraging jest, you can directly
import the code from your CLI into your test cases. This lets you get around to testing your parsing library - you don’t need to write ink tests , for example! - and call functions directly in the implementation of each of the commands.
A fine approach, especially if your CLI is largely composed of many small commands with few options or parameters.
d. Fully integrated
Each of the different libraries mentioned above supports some kind of
Command object that is used to specify the parameters, help text, etc. of the command in question. In addition to deep-importing the implementation, you can also import the command objects themselves. This allows you to perform a more integrated testing - supplying actual parameters and the like - that will more closely mirror user parameters.
3. Ignore semver/release notes
It’s easy to look at a CLI and think that the version largely doesn’t matter because humans can quickly solve for small changes. However, it’s safe to say that the version of a CLI matters just as much as any other library! The most common user of a CLI in this modern era is not a human, surprisingly, but instead other tools. Automation like CI/CD infrastructure, testing tooling, deployment artifacts, and others all expect a consistent set of rules and versions.
Violating semver guidance on a command-line tool is a fast way to bring down your customer's deployment infrastructure. As such, any changes to parameters or command line options should be treated as a minor change, if not a major, to communicate clearly to your customers that there is additional tooling work that should be done to support that version.
4. Inconsistent verbs, parameters, or configuration components
Instead of using different verbs based on what “feels good” for your CLI, use very consistent subcommand verbs across the product, even if it’s a little awkward at times. If you use
set to retrieve user profiles, for example, then also use
set for your integration functions, even if
push might feel better suited, given the underlying mechanics of the operations involved.
It’s better to be weird and consistent than perfectly logical but a guessing game for your users.
Learning a CLI is a discovery process, primarily rooted in the human brain. The more you can do to make it easy for users to extrapolate behaviors in novel sections, the faster they’ll adopt it. And, as we all know, adoption is good!
5. Build your CLI to reflect your API, instead of your user/automation tasks
Sure, you could build your CLI to be a one-for-one match with your API - there are definitely some that are simply cleaner wrappers around
superagent calls - but remember that you’re solving for tasks, not just hitting endpoints.
Think of the CLI as a butler or assistant - what tasks are your users going to have to do that are common? What tasks will the CI/CD tools have to do on every build?
Write those out and plan your set of features accordingly. Don’t expose HTTP calls directly, and don’t expect the user to pass JSON on the command line either (looking at you, AWS CLI!). You have a filesystem and all of the support of the user - make use of those elements to make the hard things trivial, and the impossible things merely difficult.
Pro-tip: Sometimes, it’s really nice to be able to specify resources - specifications, code, etc. - via a URL to an HTTP endpoint rather than requiring them to be on the filesystem! Don’t feel like you have to engineer-in-advance of the feature, but keep an eye out for little things like that to simplify your customer's experience.
(Bonus!) 6. Forget about authorization mechanisms and integrations
It’s hard to remember that your customer still needs to authenticate the CLI, just like they authenticate the browser when using your dashboard! There are a couple of models to be aware of:
- Authenticating as an end user
- Authenticating as different end users
- Authenticating as a service (like CI/CD)
While your user model may not support these things, it’s worthwhile to have a “profile” concept in your CLI that allows users to specify multiple sets of APK keys, credentials and identities when interacting with your application. This will enable developers to have test environments, separate CI/CD credentials from user credentials, and so forth.
Before you go...
If you want more developer content like this you can follow @statefulhq on Twitter or find us on Discord. Also, if you're a VS Code user you should checkout these extensions: Runme (transform Readme's into runnable notebooks), and Marquee (the open source homescreen that helps you stay organized).