OpenAPI-driven Python SDK and CLI for the SkillDock.io API.
Project description
SkillDock Python SDK and CLI
skilldock is an OpenAPI-driven Python client (and a simple CLI) for the SkillDock API.
It loads the OpenAPI spec at runtime and exposes:
- A Python
SkilldockClientthat can call anyoperationId - A CLI that can list available operations and call them from your terminal
Install
pip install skilldock
Quickstart (CLI)
List operations from the OpenAPI spec:
skilldock ops
The first column is a python-friendly python_name you can use as client.ops.<python_name>(...).
Authenticate (browser login + polling):
skilldock auth login
This starts a CLI auth session on the API, prints an auth_url, opens it in your browser, then polls until it receives an app-issued access_token and saves it as the CLI token.
Access tokens are short-lived; if you see auth errors later, run skilldock auth login again.
Create a long-lived personal API token (recommended for CI and to avoid short-lived JWT expiry):
# Prints the token (shown only once by the API) and saves it into the CLI config.
skilldock tokens create --save
# List your tokens
skilldock tokens list
Call an endpoint by operationId:
skilldock call SomeOperationId --param foo=bar --json '{"hello":"world"}'
Search skills:
skilldock skills search "docker"
skills search uses POST /v2/search and returns the same listing contract shape (page, per_page, items, has_more).
Search output includes LATEST_VERSIONS from each skill's embedded latest_releases (up to 5 items).
Get a single skill (latest metadata + latest description source):
skilldock skills get acme/my-skill
Get one exact release by version (source of truth for versioned descriptions):
skilldock skills release acme/my-skill 0.1.0
Browse release history page-by-page:
skilldock skills releases acme/my-skill --page 1 --per-page 10
Get author profile details and authored skills (paginated):
skilldock users get 123 --page 1 --per-page 20
Install a skill locally (default destination is ./skills, with recursive dependency resolution):
Public skills can be installed without auth. If a token is configured, the CLI sends it for skill discovery/install flows so private skills can be resolved when authorized.
# latest
skilldock install acme/my-skill
# exact version
skilldock i acme/my-skill --version 1.2.3
# custom local destination
skilldock install acme/my-skill --skills-dir /path/to/project/skills
Uninstall a direct skill and reconcile/remove no-longer-needed dependencies:
skilldock uninstall acme/my-skill
Verify a local skill folder (packages a zip and prints sha256/size):
skilldock skill verify .
Upload a new skill release:
skilldock skill upload --namespace myorg --slug my-skill --version 1.2.3 --path .
# Explicit private publish
skilldock skill upload --namespace myorg --slug my-skill --version 1.2.3 --path . --visibility private
This packages the folder into a zip and uploads it as multipart form field file.
For this registry, tags are read by the backend from SKILL.md frontmatter inside the uploaded zip.
There is no separate upload tags field (or CLI --tag flag) for publish.
Release versions are immutable: if you change SKILL.md (including description), publish a new version.
Re-publishing the same version for the same skill returns a conflict.
---
name: my-skill
description: Does X
version: 1.2.0
tags:
- productivity
- automation
- cli
---
Tag values should be strings; non-string values are ignored by the backend.
The CLI packages upload archives with top-level folder name equal to --slug, so keep frontmatter name aligned with your slug.
If your API supports release dependencies, you can pass them from CLI too:
# Repeatable string form:
skilldock skill upload --namespace myorg --slug my-skill --path . \
--dependency "core/base-utils@^1.2.0" \
--dependency "tools/lint@>=2.0.0 <3.0.0"
# JSON form (array or map), inline or from file:
skilldock skill upload --namespace myorg --slug my-skill --path . \
--dependencies-json @dependencies.json
If you haven't created the namespace yet:
skilldock namespaces create myorg
skilldock namespaces list
Low-level request (method + path, bypassing operationId):
skilldock request GET /health
Quickstart (Python)
from skilldock import SkilldockClient
client = SkilldockClient(
# Optional: override if needed
openapi_url="https://api.skilldock.io/openapi.json",
# base_url="https://api.skilldock.io",
token=None, # set after `skilldock auth login`
)
ops = client.operation_ids()
print("operations:", len(ops))
# Call by operationId (params are split into path/query/header based on OpenAPI metadata)
result = client.call_operation("SomeOperationId", params={"id": "123"})
print(result)
# Or call by a generated python-friendly name:
# (see `skilldock ops` output and use the `python_name`-like identifier)
# result = client.ops.someoperationid(id="123")
client.close()
Description Versioning
The registry now stores description_md per release version.
- Publish flow:
- Build/upload the zip with the intended
SKILL.mdcontent for that version. - Publish a new version each time description changes (for example,
0.1.0->0.1.1).
- Build/upload the zip with the intended
- Read flow:
- Exact version description:
GET /v1/skills/{namespace}/{slug}/releases/{version}and userelease.description_md. - Latest overview:
GET /v1/skills/{namespace}/{slug}and preferlatest_release.description_md.
- Exact version description:
- Backward compatibility:
skill.description_mdstill reflects current/latest description.- Fallback order when release description is empty:
release.description_mdskill.description_md- empty state
Configuration
The CLI stores config (including token) in a local JSON file:
skilldock config path
skilldock config show
You can set config values:
skilldock config set --base-url https://api.skilldock.io --openapi-url https://api.skilldock.io/openapi.json
skilldock config set --token "YOUR_TOKEN"
Environment variables (override config):
SKILLDOCK_OPENAPI_URLSKILLDOCK_BASE_URLSKILLDOCK_TOKENSKILLDOCK_TIMEOUT_S
Authentication Notes (Google)
This SDK assumes the API accepts a token in an HTTP header (usually Authorization: Bearer <token>).
The exact details are derived from the OpenAPI securitySchemes when present.
The SkillDock API can accept (depending on server configuration):
- Google ID token (JWT)
- App-issued access token (JWT, returned by the CLI OAuth flow)
- Personal API token (opaque string, created via
skilldock tokens create)
skilldock auth login works like this:
- Creates a CLI auth session via
POST /auth/cli/sessions - Prints the returned
auth_urland opens it in your browser - After you complete Google login, the backend approves the session
- The CLI polls
GET /auth/cli/sessions/{session_id}until it receives an app-issuedaccess_token, then saves it as the configured API token
If you want to set a token manually:
skilldock auth set-token "PASTE_TOKEN_HERE"
To create a personal API token (recommended for longer-lived auth):
skilldock tokens create --save
Development
Run the small unit test suite:
python -m unittest discover -s tests
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file skilldock-2026.2.251743.tar.gz.
File metadata
- Download URL: skilldock-2026.2.251743.tar.gz
- Upload date:
- Size: 42.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bd960a7409a980f46e164ecde220761b02cc0026db4cfea92ce275606f3a5a4a
|
|
| MD5 |
3818d41b29ca4f2f7505e2d7baac2229
|
|
| BLAKE2b-256 |
05f267819a7ab3f5052e995304eb792a81e5de7c62a184c1010f098f18cf3bd9
|
File details
Details for the file skilldock-2026.2.251743-py3-none-any.whl.
File metadata
- Download URL: skilldock-2026.2.251743-py3-none-any.whl
- Upload date:
- Size: 48.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/4.0.2 CPython/3.11.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
6a945f66cd1b791852eebe4bf8e678bace3009b0f0398ce4f011ecfa0828abca
|
|
| MD5 |
74498d2811529ac9c91ed8f8b36e07fb
|
|
| BLAKE2b-256 |
f707fc0c4ffed4caba70d17e3f2f2d89c668c45323334358d2e91e48e36cf5c4
|