> For the complete documentation index, see [llms.txt](https://docs.gofigr.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.gofigr.io/getting-started/quickstart.md).

# Quick Start

Get up and running with GoFigr in under 5 minutes.

## 1. Create an Account

Visit [app.gofigr.io/register](https://app.gofigr.io/register) and sign up for a free account.

## 2. Install the Package

{% tabs %}
{% tab title="Python" %}

```bash
pip install gofigr
```

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

{% tab title="R" %}

```r
# From CRAN
install.packages("gofigR")

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

{% endtab %}
{% endtabs %}

## 3. Configure GoFigr

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

{% tabs %}
{% tab title="Python" %}
Run in your terminal:

```bash
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!
```

{% endtab %}

{% tab title="R" %}

```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!
```

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**Prefer a guided setup?** Use the [Real-Time Capture setup wizard](/features/realtime-capture.md) in the GoFigr web app to generate a ready-to-use starter file for your environment — no manual configuration needed.
{% endhint %}

## 4. Capture Your First Figure

{% tabs %}
{% tab title="Python (Jupyter)" %}

```python
%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
  {% endtab %}

{% tab title="Python (Scripts)" %}

```python
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())
```

{% endtab %}

{% tab title="R" %}

```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")
```

{% endtab %}
{% endtabs %}

## 5. View Your Figure

1. Go to [app.gofigr.io](https://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](/getting-started/installation.md) — Detailed setup and advanced configuration
* [AI Story Mode](/features/story-mode.md) — Turn figures into presentations
* [Git Import](/features/git-import.md) — Import existing notebooks


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.gofigr.io/getting-started/quickstart.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.