Skip to content

Lag0/godspeed-sdk

Repository files navigation

@syxs/godspeed-sdk

Typed TypeScript SDK for the Godspeed task management API.

npm

Installation

npm install @syxs/godspeed-sdk

Quick Start

import { createClient, listTasks, createTask } from "@syxs/godspeed-sdk";

const client = createClient({
  token: process.env.GODSPEED_TOKEN,
});

const tasks = await listTasks(client, { status: "incomplete" });
const task = await createTask(client, { title: "Buy milk" });

console.log(tasks.length, task.id);

API Reference

Main endpoint helpers:

  • createTask(client, input)
  • listTasks(client, filters?)
  • getTask(client, taskId)
  • updateTask(client, taskId, input)
  • deleteTask(client, taskId)
  • listLists(client)
  • duplicateList(client, listId, input)

Core utilities:

  • createClient({ token, baseUrl? })
  • Zod schemas and inferred API types from src/schemas.ts / src/types.ts

Authentication

Use a Godspeed API token via GODSPEED_TOKEN or pass token directly to createClient.

export GODSPEED_TOKEN=<your-token>

API docs: https://godspeedapp.com/guides/api

Error Handling

Errors are represented by the Godspeed error hierarchy:

  • GodspeedApiError
  • GodspeedAuthError
  • GodspeedRateLimitError
  • GodspeedValidationError

Handle known errors with instanceof checks and fallback handling for unexpected failures.

Related

For command-line usage, use the standalone CLI package:

  • @syxs/godspeed-cli

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors