Grammar Checking in Bash / Unix Shell

Bash is a command-line interpreter that provides an interface for Unix-like operating systems. It's a popular scripting language for Unix, Linux, and macOS.

Sapling: AI Writing Assistant

With Sapling, you can add grammar or spell checking functionality to an existing Bash / Unix Shell application.

This page demonstrates a quick way to integrate grammar and spell checking functionality into a Bash / Unix Shell application using Sapling's API. If you are not looking for a Bash / Unix Shell guide, click here for guides for other programming languages.

Sapling does not currently maintain a Bash / Unix Shell-specific SDK, but you can access the Sapling Grammar Checking HTTP API using any programming language that supports HTTP POST requests. An example is shown below.

Setup Steps

[Register] for an account.
Visit the [dashboard] to generate an API key.
Run the code below, filling in your API key.

Bash / Unix Shell Grammar Check Quickstart

curl \
  -X POST \
  -H "Content-Type: application/json" \
  -d '{"key": "<API_KEY>", "text": "Lets get started!", "session_id": "Test Document UUID"}' \
  https://api.sapling.ai/api/v1/edits

Returned result:

{
    "edits":[
      {
          "end":4,
          "error_type":"R:OTHER",
          "general_error_type":"Other",
          "id":"aa5ee291-a073-5146-8ebc-c9c899d01278",
          "replacement":"Let's",
          "sentence":"Lets get started!",
          "sentence_start":0,
          "start":0
      }
    ]
}

Documentation

Addtional parameters and Sapling's full API documentation can be accessed here: https://sapling.ai/docs