Request early access

Docs

Getting started

This walks you from a fresh sign-in to your first change. It assumes you've installed Grixel and run grixel login.

#The idea in one minute

Grixel stores everything under one set of paths on a server, like /companies/acme/games/seasonal. Such a path is called a ref — think of it as a project's address. You check out a ref into a local folder, edit files there, and submit your changes back. A submit is all-or-nothing: it either lands completely or not at all.

#Option A — start a new project from a folder

If you have a folder of files you want to put into Grixel:

cd ~/my-game
grixel init -ref companies/acme/games/seasonal -m "initial import"

That uploads the folder's files to the new ref and turns the folder into your working copy. From now on, grixel status works here.

Keep build junk out. Regenerable output (build folders, caches, dependency directories) shouldn't go into the depot. Add a ready-made ignore list with -ignore, and combine presets for your stack by separating them with commas:

grixel init -ref companies/acme/games/seasonal -m "initial import" -ignore godot,xcode

Run grixel ignore init to see the available presets (game engines, editors, build systems, languages, and version control — add git so a project's .git/ history isn't imported). grixel ignore show <preset> prints what a preset would ignore without writing anything.

Preview the whole import first. Add -n to see exactly what would be submitted — grouped by folder, largest first — so you can catch anything you forgot to ignore. Add -v as well to list every file with its size instead of the folder summary. It uploads nothing; drop -n to import for real:

grixel init -ref companies/acme/games/seasonal -m "initial import" -ignore godot,xcode,git -n

#Option B — check out an existing project

If the project already exists on the server, pull it into a local folder:

grixel checkout companies/acme/games/seasonal ./seasonal
cd ./seasonal

If the project is large and you only need part of it, ask for just that part:

grixel checkout -path 'design/**' companies/acme/games/seasonal ./seasonal

#Make a change

Edit files in your working folder as normal. Then see what you changed:

grixel status
grixel diff

Submit it:

grixel submit -m "tune the spawn rates"

That's the whole loop: edit, status/diff to check, submit to save.

#Get other people's changes

When teammates submit, pull their work into your copy:

grixel sync

If you and someone else changed the same text file, sync leaves a conflict for you to settle — see Everyday work.

#What next