Quickstart
Get up and running with cStar in under 5 minutes. Choose your framework and follow the step-by-step guide.
Vanilla JavaScript Core SDK — works anywhere with fetch React Hooks, context provider, real-time subscriptions Svelte Rune classes, stores, reactive data fetching
Prerequisites
- A cStar account with a team created
- An API key (get one from team settings or the CLI)
- Node.js 18+ (for server-side usage)
1. Get Your API Key
The fastest way to get an API key is with the cStar CLI.
# Install the CLI
npm install -g @cstar.help/cli
# Login and create a key
cstar login --api-key sk_test_your_key_here
cstar status
You can also create keys from your team settings page or via the API.
2. Install the SDK
npm install @cstar.help/js
For React or Svelte, install the framework-specific package instead:
# React
npm install @cstar.help/react
# Svelte
npm install @cstar.help/svelte
3. Make Your First Request
index.js
import { CStarClient } from '@cstar.help/js';
const cstar = new CStarClient({
apiKey: 'sk_test_your_key_here'
});
// List open tickets
const { data: tickets } = await cstar.tickets.list({
status: 'open'
});
console.log(`You have ${tickets.length} open tickets`);