1. Home
  2. Docs
  3. Specification Reference

Specification Reference

The Specification file contains the information for a package. Typically defined in a .scriptist.json file and looks like this:

{
    "name": "Hello Polypad",
    "description": "Example script created for polypad",
    "version": "1.0.0",
    "tags": [
        "scripts",
        "polypad",
        "hello-world"
    ],
    "homepage": "https://polypad.io",
    "license": "GPL",
    "type": "script",
    "authors": [
        {
            "name": "Marcell Purham",
            "email": "m@marcell.me",
            "homepage": "marcell.me"
        }
    ],
    "repositories": [
        {
            "type": "vcs",
            "url": "https://github.com/mpurham/hello-polypad"
        }
    ]
}

Fields Overview

name

Specifies the name of the script

description

Specifies the description of the script

version

Specifies the current version of the script

tags

Specifies tags associated with the scripts functions

homepage

Specifies the homepage for the package

license

Specifies the license associated with the package and third-party scripts

type

Specifies the script type, which can be either script or library.

authors

Specifies the author of the package repositories

Specifies the repository location of the package

Was this article helpful to you? Yes No

How can we help?