Quick Start

Get up and running with Workjet in under five minutes. This guide walks you through downloading, signing in, sending your first message, connecting a tool, and creating your first skill.

Step 1: Download and Install

Download the installer for your platform from the Installation page and follow the setup instructions. Workjet is approximately 15 MB and installs in seconds.

Step 2: Sign In

Launch Workjet. You have two options to get started:

  • Sign in with Google: Click "Continue with Google" to authenticate via Google OAuth. This creates your user account and organization automatically on first sign-in. Your workspace at portal.workjet.dev is ready immediately.
  • Enter an API key: If you already have a Workjet API key (format: wj_live_...), enter it directly in the settings panel. This connects the desktop app to your existing organization.

Tip: Google sign-in is the fastest path. Your first login auto-provisions an organization, so you can start chatting immediately without any admin setup.

Step 3: Start a Chat

The chat panel is docked at the bottom of the workspace. Type your message and press Enter to send it. Your message flows through the AI gateway, where it's scanned for sensitive data, routed to the configured model, and logged for auditing.

Try something like:

Summarize the key differences between REST and GraphQL APIs in a comparison table.

You'll see the response stream in real time with token counts displayed. You can switch models mid-conversation using the model selector in the chat header.

Attach a Document

Drag a file onto the chat panel to include it as context. Supported formats include PDF, Markdown, CSV, plain text, and source code files. The AI will read the document and incorporate it into the conversation.

Step 4: Connect a Tool

Tools extend what the AI can do by connecting it to external services. To connect your first tool:

  1. Click the Connectors icon in the sidebar (the link chain icon)
  2. Click Add Connection
  3. Select a connector from the list (try Filesystem — it requires no API keys)
  4. The Connection Wizard opens with three steps:
    • Configure: Review the pre-filled command and add any required environment variables
    • Test: Click "Test Connection" to verify the server is reachable
    • Save: Save the connection. A green status indicator confirms it's active

Once connected, the AI can use that tool's capabilities during your conversations. For example, with the Filesystem connector, the AI can read and write files on your machine.

See the full list of 14 available connectors, including GitHub, Slack, PostgreSQL, Google Drive, and more.

Step 5: Create Your First Skill

Skills are reusable prompt-and-tool chains. To create one:

  1. Open the Skills tab from the sidebar
  2. Click New Skill
  3. Give your skill a name (e.g., "Meeting Summary")
  4. Write a system prompt that defines the task:
    You are a meeting notes assistant. Given raw meeting transcript
    or notes, produce a structured summary with:
    - Key decisions made
    - Action items with owners
    - Open questions
    - Follow-up dates
  5. Select the model tier (standard, premium, or enterprise)
  6. Optionally attach tools the skill needs
  7. Click Save

Your skill now appears in the skill browser. You or any team member can run it with a single click, or invoke it from the chat panel for skill-enhanced conversations.

What's Next?