Quickstart

This page is authored in MDX, so it can embed interactive React components alongside Markdown. The page below uses the <Callout> component.

MDX files (.mdx) can render components. Plain Markdown files (.md) cannot — use whichever fits the page.

Write your first script

Create a file and add the following. Lines 3–5 are highlighted to draw attention to the important part:

hello.tsx
import { createClient } from "example-cli";
 
const client = createClient({
  apiKey: process.env.EXAMPLE_API_KEY,
});
 
export default client;

Run it

Run the script and confirm the output:

const result = await client.ping();
console.log(result.status); // "ok"

Checklist

Track your progress with this task list:

  • Install the CLI
  • Create a project
  • Deploy to production

Never commit your API key to source control. Store it in an environment variable instead.

When you are ready to ship, read the Deployment guide.