Graphon Docs

Setup your environment

Create your account, choose a workspace, install the CLI, and create an API key.

Create your account

Open the sign-up page and enter your name, email address, and password. Follow the email verification steps. You can also use a sign-in provider shown on that page.

Choose your workspace

Open the Graphon app and choose the workspace where you want to store your objects. Workspaces group your buckets, members, and API keys. Check the selected workspace before you create a bucket or key.

Using a coding agent?

Install the Graphon plugin and let your agent do the rest. The plugin brings the MCP server, the skills, and the graphon CLI, which it installs when your machine does not have it.

Install the CLI

Open Terminal and run the command. It installs graphon in ~/.local/bin and adds that folder to your PATH.

curl -fsSL https://beta.graphon.ai/install.sh | sh

For other options, see the CLI installation guide. Then open a new terminal and check the installed version:

graphon --version

Sign in

graphon login opens your browser to approve the login, then stores a refresh token on your machine. Use --device on a machine with no browser.

graphon login
# On a machine with no browser, use the device flow:
graphon login --device

Create an API key

To call the HTTP API or use S3 tools, create an API key. One key works everywhere: the Graphon API, the storage API, and S3 tools. Give it the editor role, so it can create buckets and write objects.

graphon api-keys create --name "Local storage" --role editor

Graphon shows the key just once, so keep it out of your source. Now export your key, your workspace ID, and the bare JSON storage endpoint. Replace the example workspace ID with the ID that owns your key:

export GRAPHON_API_KEY="gak_..."
export GRAPHON_WORKSPACE_ID="wspq7ws2np5l8z4"
export GRAPHON_STORAGE_ORIGIN="https://storage.beta.graphon.sh"

Next step

Create your first bucket to store an object and read it back.

Was this page helpful?
View as Markdown