Smarter API Command-line Interface

The Smarter cli is a standalone application written in Go lang that runs on Windows, macOS and Linux. It is separately managed in github.com/QueriumCorp/smarter-cli . It is a lightweight command-line UI for interacting with the Smarter API .

Commands

The cli implements a set of verbs for working with Smarter resources

• apply : executes services as necessary in order to migrate a Smarter resource from its present state to that which is described in the provided manifest.
• delete : permanently, unrecoverably destroys a Smarter resource.
• deploy : manages the deploy state of a deployable Smarter resource (Plugin and ChatBot).
• describe : returns a report in yaml or json format that is a superset of a manifest describing the present state of a Smarter resource.
• logs : returns log data in standard console log format for a Smarter resource
• status : returns a report in yaml or json format that provides real-time information on the state of the Smarter platform.

Related API endpoints

• https://api.smarter.sh/v0/cli/apply/: Apply a manifest
• https://api.smarter.sh/v0/cli/describe/: print the manifest
• https://api.smarter.sh/v0/cli/deploy/: Deploy a resource
• https://api.smarter.sh/v0/cli/logs/: Get logs for a resource
• https://api.smarter.sh/v0/cli/delete/: Delete a resource
• https://api.smarter.sh/v0/cli/status/: Smarter platform status

Manifest Spec

The cli is designed to work with a manifest utf-8 text document, in yaml or json format, inspired by Kubernetes' kubectl, itself modeled on the OpenAPI Specification v3.x . The actual implementation of this specification is located here . The Smarter API can manage escaped representations of characters outside of the utf-8 standard.

Example manifest

Kind

• Account
• User
• Plugin
• ChatBot
• Chat

Broker Model

Manifest processing depends on a abstract broker service. Brokers are implemented inside of Django Views and are responsible for mapping the verb of an http request -- get, post, patch, put, delete -- to the Python class containing the necessary services for the manifest kind . Brokers are responsible for the following:

• Defining a manifest file structure using a collection of Python enumerated data types along with basic Pydantic features.
• Reading and parsing a manifest document in yaml or json format
• Validating manifests, using Pydantic models that enforce format, syntax, and data and business rule validations.
• Instantiating the correct Python class for the manifest
• Implementing the services that back http requests: get, post, patch, put, delete

Code samples

• Abstract broker
• Example implementation for Plugin broker

Controller Model

In cases where there exist multiple variations of a manifest kind , we use a Controller pattern to route a Broker to the correct Python subclass.

• Abstract controller
• Example implementation for Plugin controller as an example.