Gaffer

Gaffer

Getting Started

Get started with Gaffer in minutes.

Basic Account Setup

After you've signed up, you'll be redirected to the Gaffer dashboard.

The first thing you'll need to do is create a new organization. The user that creates the organization will automatically be made the owner and given admin privileges, including the ability to invite other users.

We currently support GitHub OAuth authentication. If you'd like to use a different authentication method, please contact us.

Create a New Project

Once you have created an organization, you'll be redirected to the dashboard. From here you can click the "New Project" button to create a new project.

The simplest way to create a new project is to use the "Manual" project creation method. This creates a new project with an API key that you can use immediately.

  1. Click "New Project" from the dashboard
  2. Enter a name for your project
  3. Click "Create Project"
  4. Copy the generated API key

API Keys

When you create a new project, an API key is automatically generated for you. This API key is used to authenticate uploads to the Gaffer API.

You can generate additional API keys from the project settings page. Each key can have a label to help you identify its purpose (e.g., "CI/CD", "Local Development").

Keep your API keys secure! Treat them like passwords. Don't commit them to version control - use secrets or environment variables instead.

Next Steps

Now that you have a project and API key, you're ready to upload your first test report. Check out: