Quick Start

Get up and running with GoFigr in under 5 minutes.

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

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

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)

R

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

• AI Story Mode — Turn figures into presentations

• Git Import — Import existing notebooks