Languages: English | 简体中文 | 繁體中文 | Français | Español | Русский | 日本語

DeckTools

DeckTools is a pnpm monorepo for Deckflow task automation.

Packages

• sdks/typescript - @deckflow/decktools-sdk, a TypeScript SDK for file upload and task APIs in Node.js and browsers.
• sdks/go - Go SDK for file upload and task APIs.
• apps/node-cli - decktools, the Node.js CLI. See apps/node-cli/README.md for usage.

Install and Build

pnpm install
pnpm build
pnpm typecheck
pnpm test

CLI

See apps/node-cli/README.md for full CLI documentation (install, config, and all commands with examples).

Build and run locally:

pnpm --filter decktools build
node apps/node-cli/dist/cli.js --help

Quick start:

decktools login
decktools config show
decktools convert slides.pptx --to pdf

SDK

See sdks/typescript/README.md for the @deckflow/decktools-sdk API, and sdks/go/README.md for the Go SDK.

Basic example:

import { createDeck } from '@deckflow/decktools-sdk';

const deck = createDeck({
  token: process.env.DECKTOOLS_TOKEN,
  spaceId: process.env.DECKTOOLS_SPACE_ID,
});

const task = await deck.convertPptToPdf({
  files: ['./slides.pptx'],
  name: 'slides',
});

const done = await deck.tasks.wait(task.id);
console.log(done.result);

Workspace Notes

• root in createDeck({ root }) is the API root address and defaults to https://app.deckflow.com/v1.
• token is sent as X-Auth-Token.
• apiKey is sent as Authorization: Bearer {apiKey}.
• Future SDKs can be added under sdks/python, sdks/java, or sdks/rust.