Blame · Line-by-line history

`README.md`

Each line is annotated with the commit that last touched it. Click any SHA to jump to that commit and see the surrounding change.

README.mdBlame79 lines · 1 contributor

Normal view Raw

63fe719Claude	1	# Gluecron for VS Code
	2
	3	AI-native git inside your editor — chat with the repo, ship PRs, run specs, voice-to-PR, and let Claude write your commit messages.
	4
	5	> The Gluecron platform: https://gluecron.com
	6
	7	## Features
	8
	9	- Repo chat — sidebar chat grounded in the current repository (uses the same retrieval/citation pipeline as the web UI).
	10	- AI commit messages — click the sparkle in the Source Control title bar to drop a Conventional Commits–style message into the input box, drafted from your staged diff.
	11	- Open in Gluecron — jump from the active file (and line) straight to its blob page on the server.
	12	- Pull requests / Issues / Standups — sidebar webviews that embed the live web UI; everything works without a second auth round-trip.
	13	- Ship a spec — turn the current file into a Gluecron spec (auto-generates a draft PR).
	14	- Voice-to-PR — open the `/voice` console for phone-first dictation.
	15
	16	## Install
	17
	18	### From a .vsix (current path)
	19
	20	```bash
	21	cd editor-extensions/vscode
	22	npm install
	23	npm run compile
	24	npx vsce package
	25	code --install-extension gluecron-vscode-0.1.0.vsix
	26	```
	27
	28	### From the marketplace (coming soon)
	29
	30	Once published, install from the Extensions panel by searching for Gluecron.
	31
	32	## Configure
	33
	34	\| Setting \| Default \| Description \|
	35	\| --- \| --- \| --- \|
	36	\| `gluecron.host` \| `https://gluecron.com` \| Override for self-hosted instances. Accepts any URL the browser would. \|
	37	\| `gluecron.defaultBranch` \| `main` \| Branch used when constructing `…/blob/<branch>/…` deep-links. \|
	38
	39	Sign in with a Personal Access Token (`glc_…`). Create one at `${host}/settings/tokens` (the admin scope is required for the commit-message API).
	40
	41	## Commands
	42
	43	\| Command \| Default trigger \|
	44	\| --- \| --- \|
	45	\| `Gluecron: Sign In (Personal Access Token)` \| Command palette \|
	46	\| `Gluecron: Chat With This Repo` \| Command palette / activity bar icon \|
	47	\| `Gluecron: Open Current File on Web` \| Editor context menu \|
	48	\| `Gluecron: Open Pull Requests` \| Command palette \|
	49	\| `Gluecron: Ship Current File as Spec` \| Command palette \|
	50	\| `Gluecron: Voice-to-PR` \| Command palette \|
	51	\| `Generate AI Commit Message` \| Source Control title bar (`$(sparkle)`) \|
	52
	53	## Screenshots
	54
	55	_Coming soon — drop PNGs into `editor-extensions/vscode/media/` and reference them here._
	56
	57	- `media/chat.png` — sidebar chat
	58	- `media/commit.png` — sparkle in the SCM title bar
	59	- `media/pulls.png` — pulls sidebar
	60
	61	## How it talks to the server
	62
	63	- `POST /api/v2/ai/commit-message` for AI-drafted commit messages (see `src/lib/ai-commit-message.ts`).
	64	- `GET /api/v2/user` to validate PATs.
	65	- The chat / pulls / issues / standups sidebars are iframes pointing at the web UI's `?embed=1` views — no separate auth surface, no duplicated rendering code.
	66
	67	## Development
	68
	69	```bash
	70	npm install
	71	npm run watch # type-check on save
	72	npm run test # node --test (pure git URL parser unit tests)
	73	```
	74
	75	To debug against a self-hosted Gluecron, set `gluecron.host` in your User Settings (e.g. `http://localhost:3000`) and reload the window.
	76
	77	## License
	78
	79	MIT — same as the rest of the Gluecron source.