Getting Started

Set up Gaffer in minutes. Create your organization, generate upload tokens, and start uploading test reports from your CI/CD pipeline to get instant visibility.

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 upload token 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 upload token

Upload Tokens

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

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

Keep your upload tokens 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 upload token, you're ready to upload your first test report. Check out: