Skip to content

Repository files navigation

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

Deckops

Deckops is a pnpm monorepo for Deckflow task automation.

Packages

  • sdks/typescript - @deckops/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 - deckops, 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 deckops build
node apps/node-cli/dist/cli.js --help

Quick start:

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

SDK

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

Basic example:

import{createDeck}from'@deckops/sdk';constdeck=createDeck({token: process.env.DECKOPS_TOKEN,spaceId: process.env.DECKOPS_SPACE_ID,});consttask=awaitdeck.convertPptToPdf({files: ['./slides.pptx'],name: 'slides',});constdone=awaitdeck.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.

About

📄 Process deck files engine at scale on cloud ☁️.

Topics

Resources

Contributing

Stars

9 stars

Watchers

6 watching

Forks

Releases

Packages

Contributors

Languages