Quick Start

Get up and running with GoFigr in under 5 minutes.

Tip

On GoFigr Managed Compute? Skip this page — compute instances come with GoFigr preinstalled and preconfigured, so there’s nothing to set up. Head straight to Launch Your First Instance.

1. Create an Account

Visit app.gofigr.io/register and sign up for a free account.

2. Install the Package

Python

pip install gofigr

This installs both the client library and the IPython extension (compatible with Jupyter, VSCode, and others).

R

# From CRAN
install.packages("gofigR")

# Or from GitHub (development version)
library(devtools)
devtools::install_github("gofigr/gofigR")

3. Configure GoFigr

Run the configuration wizard to set up your credentials and default workspace.

Python

Run in your terminal:

gfconfig

You’ll be prompted for:

• Username: Your GoFigr username
• Password: Your GoFigr password
• API Key: Leave blank to generate a new key
• Key Name: A descriptive name (e.g., “My Laptop”)
• Default Workspace: Select from your available workspaces

Example session:

$ gfconfig
------------------------------
GoFigr configuration
------------------------------
Username: alyssa
Password:
Verifying connection...
  => Authenticated successfully
API key (leave blank to generate a new key):
Key name: Alyssa's Macbook
  => Your new API key will be saved to /Users/alyssa/.gofigr

Please select a default workspace:
  [ 1] - Scratchpad - alyssa's personal workspace
Selection [1]: 1

Configuration saved to /Users/alyssa/.gofigr. Happy analysis!

R

library(gofigR)
gfconfig()

You’ll be prompted for:

• Username: Your GoFigr username
• Password (for initial key generation)
• API Key: Leave blank to generate a new key
• Key Name: A descriptive name (e.g., “My Laptop”)
• Default Workspace: Select from your available workspaces

Example session:

> gfconfig()
-------------------------------------------------------------------
Welcome to GoFigr! This wizard will help you get up and running.
-------------------------------------------------------------------

Username: alyssa
Testing connection...
  => Success

API key (leave blank to generate a new one):
Key name (e.g. Alyssa's laptop): My laptop

1. Scratchpad - e5249bed-40f0-4336-9bd3-fef30d3ed10d

Please select a default workspace (1-1): 1

Configuration saved to /Users/alyssa/.gofigr. Happy analysis!

Note

Prefer a guided setup? Use the Real-Time Capture setup wizard in the GoFigr web app to generate a ready-to-use starter file for your environment — no manual configuration needed.

4. Capture Your First Figure

Python (Jupyter)

%load_ext gofigr

import matplotlib.pyplot as plt

# Create a figure - it's automatically captured!
plt.plot([1, 2, 3], [1, 4, 9])
plt.title("My First GoFigr Figure")

That’s it! GoFigr will:

• Automatically use your default workspace from gfconfig
• Create an analysis named after your notebook
• Capture all figures with their source code

Python (Scripts)

import matplotlib.pyplot as plt
from gofigr.publisher import Publisher

# Initialize the publisher
pub = Publisher(workspace="My Workspace", analysis="Script Analysis")

# Create a figure
plt.plot([1, 2, 3], [1, 4, 9])
plt.title("My First GoFigr Figure")

# Publish it
pub.publish(plt.gcf())

R

library(gofigR)

# Enable GoFigr
gofigR::enable()

# Create and publish a figure
library(ggplot2)

p <- ggplot(mtcars, aes(x = wt, y = mpg)) +
  geom_point() +
  ggtitle("My First GoFigr Figure")

publish(p, "Weight vs MPG")

5. View Your Figure

1. Go to app.gofigr.io
2. Navigate to your workspace
3. Find your figure with full source code attached!

The figure will appear with a QR code and unique revision ID, allowing you to track it in the GoFigr web app.

---

Next Steps

• Installation Guide — Detailed setup and advanced configuration
• Managed Compute — Prefer a zero-setup cloud machine? Launch one with GoFigr already installed
• AI Story Mode — Turn figures into presentations
• Git Import — Import existing notebooks