Graphite

https://graphite.com/docs
Admin
Graphite is a developer tool for creating, stacking, and submitting pull requests efficiently with...
Tokens:204,545
Snippets:1,845
Trust Score:10
Update:1 week ago
Show doc for...
Tokens:
Raw
### Install Graphite CLI via npm and verify version

Source: https://graphite.com/docs/install-the-cli

Alternative installation method using npm. Installs the Graphite CLI globally and then verifies the installation by checking the version.

```bash
npm install -g @withgraphite/graphite-cli@stable
gt --version

```

--------------------------------

### Install Graphite CLI via Homebrew and verify version

Source: https://graphite.com/docs/install-the-cli

Recommended installation method for macOS and Linux. Installs the Graphite CLI via Homebrew and then verifies the installation by checking the version.

```bash
brew install withgraphite/tap/graphite
gt --version

```

--------------------------------

### Verify gt installation method with which gt

Source: https://graphite.com/docs/troubleshooting

Run in a *nix system to confirm which CLI installation method has been used before downgrading.

```Terminal
which gt

```

--------------------------------

### GET /activity-feed request and response

Source: https://graphite.com/docs/create-a-pull-request

Example response for the activity feed API. The endpoint GET /activity-feed returns a JSON array with two dummy items, used to help frontend engineers start building UI components. Contains both the request line and the displayed JSON response.

```http
GET /activity-feed


[
  { id: 1, title: "Photo uploaded", body: "Alice uploaded a photo" },
  { id: 2, title: "Comment on post", body: "Charlie commented on Bob's post" },
]

```

--------------------------------

### gt trunk --all - show all configured trunks

Source: https://graphite.com/docs/multiple-trunks

Prints all configured trunks. Example output shows 'main' and 'deploys'.

```terminal
> gt trunk --all
main
deploys

```

--------------------------------

### Pull a coworker's branch with gt get

Source: https://graphite.com/docs/collaborate-on-a-stack

Shows how coworker B pulls the branch to their machine. `gt get my_branch` syncs all branches that `my_branch` depends on, starting from the bottom of the stack. If branches already exist locally and differ, Graphite will ask to overwrite or rebase.

```bash
gt get my_branch

```

--------------------------------

### Stack on top of a coworker's branch with gt get, touch, and gt create

Source: https://graphite.com/docs/collaborate-on-a-stack

Shows how to build on top of a coworker's changes. Run `gt get` on the branch, make changes, and run `gt create` to create a new stack. Then run `gt submit` when ready.

```bash
gt get "my-coworkers-frontend-changes"
touch analytics.js
gt create -m "add-analytics"

```

--------------------------------

### Change directory and initialize gt

Source: https://graphite.com/docs/create-a-pull-request

Prepare a repository for use with the gt CLI. The first command changes to an existing repository; the second initializes gt in that repo. Run gt init only on first use, then select your trunk branch (often main or master) when prompted.

```bash
cd ~/path/to/your/repo

```

```bash
gt init

```

--------------------------------

### Define aliases in aliases file

Source: https://graphite.com/docs/llms-full.txt

Example `aliases` file content. The first word is the alias, the second is the command, and following words are flags. Lines starting with `#` are ignored. Default aliases for `ss`, `ls`, and `ll` are defined.

```text
# this line is ignored
ls log short
ll log long
ss submit --stack
```

--------------------------------

### gt create --insert output

Source: https://graphite.com/docs/edit-branch-order

Example output after running gt create --insert. Shows the commit created and the restack of dependent branches.

```text
[inserted_branch bad2ec6] inserted_branch
 1 file changed, 0 insertions(+), 0 deletions(-)
 create mode 100644 inserted_branch
Restacked second_branch on inserted_branch.

```

--------------------------------

### Create and submit a branch with gt create and gt submit

Source: https://graphite.com/docs/collaborate-on-a-stack

Shows how coworker A creates and submits a branch. Run `gt create my_branch -m "My changes"` then `gt submit` to push the branch to Graphite.

```bash
gt create my_branch -m "My changes"
gt submit

```

--------------------------------

### Good example 1: Security rule with clear structure

Source: https://graphite.com/docs/ai-review-customization

This is a good example of a custom rule that follows the recommended structure: Rule → Bad example → Good example → Reasoning. It provides a specific security rule with contrasting examples and reasoning.

```markdown
### Good example 1: Security rule with clear structure

## Security Rules

### Rule: Never expose detailed error messages

**Rule:**
Never expose detailed error messages that reveal stack traces or internal system details. In production environments, always return generic error messages to protect the system while logging full details internally for debugging.

**Bad example:**
```js
app.use((err, req, res, next) => {
  res.status(500).json({ error: err.stack });
});
```

**Good example:**
```js
app.use((err, req, res, next) => {
  res.status(500).json({ error: "Internal Server Error" });
});
```

**Reasoning:**
Revealing stack traces or internal error details can leak sensitive implementation information, making it easier for attackers to exploit vulnerabilities.

```

--------------------------------

### Good example 2: Database rule with specific context

Source: https://graphite.com/docs/ai-review-customization

This is a good example of a custom rule that provides specific context and actionable guidance, contrasting with the vague bad example.

```markdown
### Good example 2: Database rule with specific context

```

--------------------------------

### Select Repository-level settings

Source: https://graphite.com/docs/multiple-trunks

Interactive menu shown after running `gt config`. Select 'Repository-level settings' to access trunk configuration.

```terminal
? What would you like to configure? › - Use arrow-keys. Return to submit.
❯   Repository-level settings
    Branch naming settings
    Submit settings
    Restack settings
    Default utilities
    Tips
    Yubikey reminders
    Exit

```
Tokens:
Raw