TipCLI

SDK integration docs

Add one privacy-safe sponsor card to your CLI output. The SDK never reads source code, terminal logs, `.env` files, or dependency manifests.

Install path

Start from your project dashboard. It creates the one-time publisher key and shows the exact snippet for that project. During private launch, use the dashboard snippet with the local workspace package. Public npm install begins only after `pnpm npm:publish:check` proves the package is published and fetchable.

Private launch path that works now

  1. 1. Create a project in the dashboard.
  2. 2. Store the one-time publisher key as `TIPCLI_PUBLISHER_KEY`.
  3. 3. Use the local workspace package or dashboard snippet.
  4. 4. Treat local renders as non-payable integration checks.

Public npm path

Run this only after the npm publish gate passes and the registry can fetch the exact version.

pnpm add @tipcli/sdk

Use

import { showSponsorCard } from "@tipcli/sdk";

await showSponsorCard({
  publisherKey: process.env.TIPCLI_PUBLISHER_KEY,
  surface: "cli-startup",
  category: "frontend",
});

Before you count delivery as payable

Local testing proves rendering only. Paid delivery starts after your project is reviewed, the integration uses a live publisher key, a paid reviewed campaign matches the project, and payout readiness is clear in the dashboard.

  1. 1. Create projectUse the dashboard to create a project and copy the one-time publisher key.
  2. 2. Test safelyUse local API overrides, CI, disabled mode, or fixture/internal delivery for non-payable tests.
  3. 3. Pass reviewTipCLI reviews the repo, placement surface, usage signal, and payout contact.
  4. 4. Serve live trafficOnly eligible projects with live delivery and paid reviewed campaigns can create payout evidence.

CI-safe

The SDK returns immediately when process.env.CI is set.

User opt-out

Developers can set TIPCLI_DISABLED=1.

Silent failure

Network errors, timeouts, and API failures never break your CLI.

Minimal fields

The SDK sends publisherKey, surface, category, sdkVersion, sessionId, and non-payable delivery flags for CI/test/disabled runs.

Stripe Connect payouts

Dashboard payout readiness uses real campaign terms and verified impressions. Stripe Connect is the primary launch payout path; manual transfer is an operator fallback only.

No fake balances

Gross delivery value, verified payable, pending payout, and paid payout are separate states so projected money is never presented as money owed.

Payout policy

Before enabling paid delivery, read how TipCLI treats verified impressions, excluded traffic, Stripe Connect payout readiness, and the manual fallback rules.

Payout policy