Documentation
Graphlit, end to end
Fourteen chapters covering both halves of the product: the board in your browser, where the architecture is decided, and the terminal, where it gets built. Every recording on these pages is a real session against the live deployment.
Getting started
From nothing installed to a build running on your machine.
- Installing the CLIOne command, one file, no runtime. This chapter is what it does, in order, and how to undo it.
- Your first ten minutesFive commands and one button. Everything after this chapter is detail.
- Signing inTwo ways in: a browser you approve once, or a key you paste into CI. Neither puts a password on your disk.
Working
The loop you are in every day: tasks, execution, keeping it true.
- Folders and projectsA project is a row on the deployment and a folder on your disk. This is the piece of string between them.
- How a build actually runsThe most surprising thing about Graphlit is where the code gets written. Not on a server: in your checkout, by your agent, under your login.
- Managing the planA plan is an ordered list of atomic tasks, each one scoped to part of the graph. Both surfaces read and write the same list.
- Keeping the graph trueAnyone can turn a sketch into code once. The question that matters in week three is whether the picture still describes what you have.
The two sides
The terminal and the browser, and what each one is better at.
- The board in the browserThe terminal is where code gets built. The browser is where the architecture gets decided — and where you watch the building happen.
- Working with other peopleA project is not one person and one laptop. This is how more than one of each works.
- Maintaining a projectThe first hour is drawing and building. Everything after it is keeping two things, a drawing and a codebase, from quietly disagreeing.
Reference
Every command, every flag, every file, and what to do when it breaks.
- The API, CI and editorsEverything in the CLI is available as JSON, and everything about signing in has an answer that needs no browser.
- Command referenceSixteen commands, and every one of them is in the published binary — `graph 0.1.5`, which is what `curl | sh` installs today.
- Files, settings and environmentShort, and worth reading once: most confusing behaviour is a value coming from a layer you forgot about.
- When something is wrongStart with `graph status`. It answers most of this page in four lines and needs no page load.
14 chapters. Something missing or wrong? Tell us.