About this project
DeckTools is a pnpm monorepo for Deckflow task automation, designed to process deck files at scale on the cloud. The repository contains three main packages: a TypeScript SDK (`@deckflow/decktools-sdk`) for file upload and task APIs in Node.js and browsers, a Go SDK for the same APIs, and a Node.js CLI (`decktools`) for command-line usage.
Installation and building are straightforward with pnpm: run `pnpm install`, `pnpm build`, `pnpm typecheck`, and `pnpm test` to set up the workspace. The CLI can be built and run locally via `pnpm --filter decktools build` followed by `node apps/node-cli/dist/cli.js --help`.
The CLI supports login, configuration management, and file conversion commands. A quick start involves running `decktools login`, `decktools config show`, and `decktools convert slides.pptx --to pdf` to convert PowerPoint files to PDF.
The TypeScript SDK provides a `createDeck` function that accepts a token, space ID, and optional API root address (defaulting to `https://app.deckflow.com/v1`). Authentication is handled via `X-Auth-Token` header for tokens or `Authorization: Bearer` for API keys. The SDK exposes methods like `convertPptToPdf` for file conversion and `tasks.wait` for polling task completion.
The workspace is structured to support future SDK additions under `sdks/python`, `sdks/java`, or `sdks/rust`, indicating plans for broader language coverage. Each package has its own README with detailed documentation for installation, configuration, and usage examples.
Comments
0 Rating appears after 10 ratings
Sign in to join the discussion.