Documentation
¶
Overview ¶
Package gadak embeds the built web UI so a release is one self-contained binary. `npm run build` writes web assets to dist/app before `go build`; without that step the embed carries only the committed placeholder and WebUI reports ok=false, which `gadak serve` turns into a helpful error.
It also embeds the Claude Code skill (skills/gadak/SKILL.md) so `gadak skill install` works for brew installs without a source checkout.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SkillMarkdown ¶
func SkillMarkdown() []byte
SkillMarkdown returns the embedded Claude Code skill body (skills/gadak/SKILL.md). Callers must not modify the returned slice.
Types ¶
This section is empty.
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
gadak
command
export-static freezes the demo mirror into static JSON + attachment bytes for the zero-install hosted demo (GitHub Pages).
|
export-static freezes the demo mirror into static JSON + attachment bytes for the zero-install hosted demo (GitHub Pages). |
|
internal
|
|
|
adf
Package adf flattens Atlassian Document Format (ADF) JSON to plain text.
|
Package adf flattens Atlassian Document Format (ADF) JSON to plain text. |
|
atlhttp
Package atlhttp is the shared HTTP transport for Atlassian Cloud clients (Jira, Confluence): retries, backoff, path safety, and optional usage meters.
|
Package atlhttp is the shared HTTP transport for Atlassian Cloud clients (Jira, Confluence): retries, backoff, path safety, and optional usage meters. |
|
attachcache
Package attachcache stores attachment bytes on local disk.
|
Package attachcache stores attachment bytes on local disk. |
|
clitool
Package clitool installs the gadak binary onto PATH via a symlink.
|
Package clitool installs the gadak binary onto PATH via a symlink. |
|
config
Package config loads and saves ~/.gadak/config.json.
|
Package config loads and saves ~/.gadak/config.json. |
|
confluence
Package confluence is a thin REST client for Confluence Cloud: enough of the API to fill the page mirror, and nothing else.
|
Package confluence is a thin REST client for Confluence Cloud: enough of the API to fill the page mirror, and nothing else. |
|
deeplink
Package deeplink parses and builds the gadak:// URLs that hand a piece of gadak to someone — a link in chat or on a web page instead of a shell, a running serve, and a command with side effects.
|
Package deeplink parses and builds the gadak:// URLs that hand a piece of gadak to someone — a link in chat or on a web page instead of a shell, a running serve, and a command with side effects. |
|
fields
Package fields classifies and discovers Jira custom fields for the mirror.
|
Package fields classifies and discovers Jira custom fields for the mirror. |
|
jira
Package jira is the Atlassian Cloud REST client: read paths plus user-initiated writes.
|
Package jira is the Atlassian Cloud REST client: read paths plus user-initiated writes. |
|
jql
Package jql translates a documented JQL subset to and from gadak's in-memory filter (the same shape the web UI serializes into the URL).
|
Package jql translates a documented JQL subset to and from gadak's in-memory filter (the same shape the web UI serializes into the URL). |
|
mcp
Package mcp implements a thin stdio MCP server over the local gadak mirror.
|
Package mcp implements a thin stdio MCP server over the local gadak mirror. |
|
secretscan
Package secretscan holds the credential-shaped string patterns that every outbound artifact is checked against before it is written.
|
Package secretscan holds the credential-shaped string patterns that every outbound artifact is checked against before it is written. |
|
selfupdate
Package selfupdate answers one question — is a newer release published? — with one GitHub API call a day, cached on disk.
|
Package selfupdate answers one question — is a newer release published? — with one GitHub API call a day, cached on disk. |
|
server
Package server is the loopback HTTP mux for the web UI and the API (specs/000-product/contracts/api.md).
|
Package server is the loopback HTTP mux for the web UI and the API (specs/000-product/contracts/api.md). |
|
snapshot
Package snapshot builds shareable mirror copies for demos and benchmarks.
|
Package snapshot builds shareable mirror copies for demos and benchmarks. |
|
store
Package store owns the SQLite mirror: schema, migrations, transactions, full-text index and the derived fields the source does not provide.
|
Package store owns the SQLite mirror: schema, migrations, transactions, full-text index and the derived fields the source does not provide. |
|
sync
Package sync fills the mirror from the configured sources (Jira, and Confluence when enabled).
|
Package sync fills the mirror from the configured sources (Jira, and Confluence when enabled). |
|
teamconfig
Package teamconfig builds and applies team-shareable gadak configuration files (views, field maps, group rules, …) without credentials or personal machine prefs.
|
Package teamconfig builds and applies team-shareable gadak configuration files (views, field maps, group rules, …) without credentials or personal machine prefs. |
|
uifocus
Package uifocus is the one-shot handoff from the CLI to a running UI.
|
Package uifocus is the one-shot handoff from the CLI to a running UI. |
|
workspace
Package workspace mounts additional gadak profiles under /w/<name>/ and lists them at GET /api/v1/workspaces.
|
Package workspace mounts additional gadak profiles under /w/<name>/ and lists them at GET /api/v1/workspaces. |
|
tools
|
|
|
bench-fixture
command
Command bench-fixture builds a deterministic synthetic gadak.db for latency benchmarks (T6.7 / G5).
|
Command bench-fixture builds a deterministic synthetic gadak.db for latency benchmarks (T6.7 / G5). |
|
seed-demo
command
Command seed-demo populates a throwaway Jira Cloud site with a realistic demo backlog for gadak screenshots and examples/demo.db.
|
Command seed-demo populates a throwaway Jira Cloud site with a realistic demo backlog for gadak screenshots and examples/demo.db. |
Click to show internal directories.
Click to hide internal directories.