clify

Search the catalogue of 135 real websites clify can call (package registries, government data, science, news, jobs, weather, culture…). Pass a keyword query to get the best sites with their matching commands. Without a query it pages through the catalogue, one line per site ("name (category, commands): about"); filter with category. Start here.

{
  "type": "object",
  "properties": {
    "query": {
      "description": "what you need, e.g. \"rust crate versions\" or \"weather forecast\"",
      "type": "string"
    },
    "category": {
      "type": "string",
      "enum": [
        "culture",
        "dev",
        "gov-eu",
        "gov-nordic",
        "gov-us",
        "jobs-market",
        "maps-weather",
        "news",
        "sandbox",
        "science",
        "sports-ent"
      ]
    },
    "limit": {
      "description": "max sites (default 6 with a query, 40 per page without)",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "offset": {
      "description": "skip this many sites when paging the catalogue (see nextPage)",
      "type": "integer",
      "minimum": 0,
      "maximum": 9007199254740991
    }
  },
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

A site's commands with params ("name*" = required, ":a|b" = allowed values, "=x" = default). Pass command for full param docs, default fields and a ready clify_run call.

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "description": "site name from clify_sites, e.g. crates, weather"
    },
    "command": {
      "description": "one command name for full details",
      "type": "string"
    }
  },
  "required": [
    "site"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

Call one command of a clify site and get JSON back. args holds the command's params (see clify_help). Lists return count, total and nextPage (args for the next page). Write commands return a dry-run preview unless confirm:true.

{
  "type": "object",
  "properties": {
    "site": {
      "type": "string",
      "description": "site name, e.g. crates"
    },
    "command": {
      "type": "string",
      "description": "command name, e.g. get-crate"
    },
    "args": {
      "description": "params, e.g. {\"name\":\"serde\"}",
      "type": "object",
      "propertyNames": {
        "type": "string"
      },
      "additionalProperties": {
        "type": [
          "string",
          "number",
          "boolean"
        ]
      }
    },
    "fields": {
      "description": "comma-separated keys to keep (dot paths ok); \"*\" for all",
      "type": "string"
    },
    "limit": {
      "description": "first N items of a list",
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    },
    "confirm": {
      "description": "true sends a write; otherwise writes return a preview",
      "type": "boolean"
    }
  },
  "required": [
    "site",
    "command"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

crates.io: Get a crate's details: description, links, download totals, keywords, categories and default version Returns name, description, default_version, downloads, recent_downloads, num_versions, keywords, categories, repository, documentation, homepage, updated_at by default. (Same as clify_run site=crates command=get-crate.)

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Crate name"
    },
    "fields": {
      "description": "keys to keep; \"*\" for all",
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

pypi.org: Get a package's PyPI page for its latest version: name and version, summary, pip install command, project links and metadata sidebar, and README text. Returns name_version, summary, pip_command, sidebar, description by default. (Same as clify_run site=pypi command=get-package.)

{
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Package name as it appears on PyPI, e.g. requests"
    },
    "fields": {
      "description": "keys to keep; \"*\" for all",
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "name"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

en.wikipedia.org: Short summary of an article (title, description, extract, url) Returns title, description, extract, content_urls.desktop.page by default. (Same as clify_run site=wikipedia command=summary.)

{
  "type": "object",
  "properties": {
    "title": {
      "type": "string",
      "description": "article title, spaces as underscores, e.g. Y_Combinator"
    },
    "fields": {
      "description": "keys to keep; \"*\" for all",
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "title"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}

hn.algolia.com: Search stories/comments by relevance Returns title, points, num_comments, author, created_at, url, objectID by default. (Same as clify_run site=hnsearch command=search.)

{
  "type": "object",
  "properties": {
    "query": {
      "type": "string"
    },
    "tags": {
      "type": "string",
      "enum": [
        "story",
        "comment",
        "ask_hn",
        "show_hn",
        "poll"
      ],
      "description": "default story"
    },
    "page": {
      "type": "number"
    },
    "hitsPerPage": {
      "type": "number"
    },
    "fields": {
      "description": "keys to keep; \"*\" for all",
      "type": "string"
    },
    "limit": {
      "type": "integer",
      "exclusiveMinimum": 0,
      "maximum": 9007199254740991
    }
  },
  "required": [
    "query"
  ],
  "$schema": "https://json-schema.org/draft/2020-12/schema"
}