//docs

Documentation

Install githook, link your wallet, publish your first skill, earn tips. Everything you need in one page.

01 · quickstart

Five minutes, five steps.

From no GitHook to your first skill earning tips. You need an EVM wallet on Base and ~$0.10 of Ethereum$ETH for gas.

01
install githook CLI
curl -fsSL https://githook.ai/install.sh | sh
02
start githook
githook
03
connect your wallet
/wallet link
04
create & push a skill
/skill new my-skill && /skill push
05
receive tips
/tips
02 · install

Install githook CLI.

macOS / Linux — paste in Terminal
bash
$ curl -fsSL https://githook.ai/install.sh | sh
→ downloading githook binary...
✓ githook installed to /usr/local/bin/githook

Auto-updates on startup. Re-run any time to force upgrade.

what's included
Free forever — no API keys, no credit card
Premium coding on Claude Opus 4.7 — model bill on us
File editing, code execution, git integration
Skill marketplace integration
Windows (via WSL2)
wsl --install && curl -fsSL https://githook.ai/install.sh | sh
03 · command reference

All githook commands.

live implemented and shippedphase 2 planned after $GITHOOK launch

Wallet & Identity

CommandWhat it doesStatus
/walletShow wallet status, DID, and session infolive
/wallet linkConnect wallet via browser (WalletConnect, MetaMask, Coinbase)live
/wallet balanceCheck $ETH balance on Baselive

Skills — Create & Publish

CommandWhat it doesStatus
/skill new <name>Create SKILL.md template in a new directorylive
/skill validate [path]Validate SKILL.md manifest (local lint)live
/skill push [path]Publish skill to GitHook marketplace (signed request)live
/skill listList your published skillslive

Skills — Browse & Install

CommandWhat it doesStatus
/skillsBrowse skills in the marketplacelive
/skills install <author/name>Install a skill from the marketplacelive

Tips & Earnings

CommandWhat it doesStatus
/tip <author/skill> <amount>Tip a skill creator in $ETH (100% to creator, 0% protocol fee)live
/tip-confirm <tx-hash>Confirm a tip transaction on-chainlive
/tipsView your tip history (sent/received)live

Chat & Session

CommandWhat it doesStatus
/clearClear conversation historylive
/save [name]Save current conversationlive
/load [name]Load a saved conversationlive
/retryRetry the last messagelive

Git Integration

CommandWhat it doesStatus
/commit [message]Commit staged changes (AI-generated message if omitted)live
/diffShow unstaged changeslive
/statusShow git statuslive

Settings & Info

CommandWhat it doesStatus
/settingsOpen settings menulive
/modelChange AI modellive
/providerChange AI providerlive
/usageView token usage and cost statslive
/aboutAbout GitHook platformlive
/helpShow all available commandslive
/exitQuit githooklive

File References

CommandWhat it doesStatus
@file.tsInclude file content in your messagelive
@folder/Include folder structurelive
@file.ts:10-20Include specific lines (10-20)live

Node Operator (Phase 2 — after $GITHOOK launch)

CommandWhat it doesStatus
githook node register --stake <amount>Register a node on NodeStaking.solphase 2
githook node statusCheck stake, tier, uptime, pending rewardsphase 2
githook node claimClaim accumulated rewards ($ETH)phase 2
04 · SKILL.md format

Anatomy of a skill.

SKILL.md
---
name: code-reviewer
title: Code Reviewer Pro
version: 1.0.0
author: alice
license: MIT
description: Reviews code for bugs
category: development
tags:
- code-review
- security
tip_enabled: true
---
# Code Reviewer Pro
You are an expert code reviewer...
Required fields
  • name — unique identifier (lowercase, dashes)
  • title — display name
  • version — semver (1.0.0)
  • author — your username
  • description — one-line summary
  • category — development, writing, etc.
Optional fields
  • license — defaults to MIT
  • tags — array for discovery
  • tip_enabled — true by default
  • permissions — fs:read, net:fetch, etc.
Note: wallet is automatically set from your linked wallet when you push.
05 · FAQ

Frequent questions.

What is githook?
githook is an AI code assistant that runs in your terminal. It's free forever — no API keys, no credit card — with premium coding on Claude Opus 4.7 covered server-side, and it integrates with the GitHook skill marketplace.
Do I need crypto experience?
Just an EVM wallet (MetaMask, Rabby, Coinbase Wallet) and a small amount of $ETH on Base for gas (~$0.01 per tip). Wallet linking happens via browser — no complex setup.
Does GitHook take a cut of tips?
No. Tips are a plain wallet-to-wallet $ETH transfer on Base — straight from the tipper to the creator. There's no contract in between and no protocol fee, so 100% of every tip lands in the creator's wallet. GitHook only provides the page.
How do I get paid for my skills?
When someone tips your skill, 100% of it is sent directly from their wallet to yours in the same transaction, on Base. No middleman, no fee, no waiting on a payout.
Can I use githook without publishing skills?
Absolutely. githook is a full-featured AI code assistant. You can use it to chat, edit code, run commands, and more — without ever publishing a skill or connecting a wallet.
What if GitHook disappears?
The CLI is MIT-licensed and open source, and tips are direct wallet-to-wallet $ETH transfers — they never depend on GitHook's servers. Your skills live on, and your earnings always go straight to your wallet.
How does the security review work?
Every skill push runs through a security scanner (30+ patterns) and AI moderator. Critical findings reject immediately. Skills with high trust scores can be auto-approved; others go to admin review.