Getting Started¶
Requirements¶
- Node.js 18 or newer
Run without installing¶
Install globally¶
From source¶
git clone https://github.com/Ayush7614/personal-context.git
cd personal-context
pnpm install
pnpm build
# run the built CLI
node packages/cli/dist/index.js all
# or link it globally
cd packages/cli && npm link
personal-context all
First run¶
-
Create a config in the current directory:
-
Open
personal.yamland fill in your details and source handles (see Configuration). -
View your profile:
GitHub token (optional)
Set GITHUB_TOKEN to unlock contribution + pull-request counts and higher
rate limits. Public repo and star data works without it.
Config discovery
The CLI looks for personal.yaml in the current directory and walks up
parent directories, so run it from anywhere inside your project.