Skip to content

feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
KylinMountain merged 3 commits into from
May 17, 2026
Merged

feat(cli): add openkb feedback to file a prefilled GitHub issue #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9ca0270
feat(cli): add 'openkb feedback' to file a prefilled GitHub issue
KylinMountain May 17, 2026
18dd708
fix(feedback): address 3 self-review findings
KylinMountain May 17, 2026
dad19e5
docs(feedback): drop --print-url and --no-diagnostics, keep one flag
KylinMountain May 17, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down
151 changes: 151 additions & 0 deletions openkb/cli.py
View file
Open in desktop
Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
click.echo("No knowledge base found. Run `openkb init` first.")
return
print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
"bug": "bug",
"feature": "enhancement",
"question": "question",
"other": "",
}


def _openkb_version() -> str:
"""Return the installed openkb package version.

Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
body, and any future caller all surface the same fallback string
(``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
``openkb.agent.chat._openkb_version``.
"""
from openkb import __version__
return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
"""Auto-collect non-sensitive environment info to attach to a feedback
issue. Kept deliberately small — no paths, no API keys, no usernames.
"""
import platform

kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
return {
"openkb": _openkb_version(),
"python": platform.python_version(),
"platform": f"{platform.system()} {platform.release()}",
"kb_initialised": "yes" if kb_dir else "no",
}


def _build_feedback_url(
message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
"""Build a GitHub issue URL with title / body / labels prefilled."""
from urllib.parse import urlencode

first_line = message.splitlines()[0] if message else ""
truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

if diagnostics:
diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
body = (
f"{message}\n\n"
"---\n\n"
"<details>\n"
"<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
f"{diag_block}\n"
"</details>\n"
)
else:
body = message

params = {"title": title, "body": body}
label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
if label:
params["labels"] = label

return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
"--type", "feedback_type",
type=click.Choice(_FEEDBACK_TYPES),
default=None,
help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
"""Submit feedback by opening a prefilled GitHub issue.

Examples:

\b
openkb feedback # interactive
openkb feedback "openkb add hangs on .docx" # one-line bug report
openkb feedback --type feature "..." # tags the issue 'enhancement'

The command does not send anything to OpenKB maintainers directly —
it opens GitHub in your browser with title, body, and label prefilled.
You log in with your own GitHub account and submit the issue.
"""
if not message:
click.echo(
"What's your feedback? End with an empty line + Ctrl-D "
"(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
)
message = sys.stdin.read().strip()

if not message:
click.echo("No feedback provided. Aborted.")
ctx.exit(1)
return

if feedback_type is None:
# Skip the prompt in non-TTY contexts (CI / piped stdin) so
# ``echo "msg" | openkb feedback`` doesn't hang on the second
# prompt after consuming all piped input for the message body.
# Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
if _stdin_is_tty():
feedback_type = click.prompt(
"Type",
default="other",
type=click.Choice(_FEEDBACK_TYPES),
show_default=True,
show_choices=True,
)
else:
feedback_type = "other"

diagnostics = _collect_feedback_diagnostics(ctx)
url = _build_feedback_url(message, feedback_type, diagnostics)

click.echo("Copy this URL into a browser if the auto-open below fails:")
click.echo(f" {url}")

import webbrowser
try:
opened = webbrowser.open(url)
except Exception as exc:
# webbrowser.open rarely raises but be defensive — the printed URL
# above is the fallback path.
click.echo(f" (browser auto-open failed: {exc})", err=True)
return

# ``webbrowser.open`` returns False on headless boxes (no GUI, no
# ``BROWSER`` env) without raising. Without this check we'd silently
# print "Opened" and the user would think the issue was filed.
if opened:
click.echo("Opened GitHub in your browser.")
else:
click.echo(
" (no browser available — copy the URL above to file the issue)",
err=True,
)
Loading
, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
feat(cli): add `openkb feedback` to file a prefilled GitHub issue by KylinMountain · Pull Request #53 · VectifyAI/OpenKB · GitHub
Skip to content
feat(cli): add openkb feedback to file a prefilled GitHub issue#53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

 Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and
privacy statement. We’ll occasionally send you account related emails.

Already on GitHub?
Sign in
to your account

 Merged

KylinMountain
merged 3 commits into

from

May 17, 2026
 Merged


feat(cli): add openkb feedback to file a prefilled GitHub issue
#53
Show file tree
Hide file tree
 Changes from all commits
Commits

Show all changes


3 commits


Select commit
Hold shift + click to select a range
9ca0270

feat(cli): add 'openkb feedback' to file a prefilled GitHub issue


KylinMountain May 17, 2026
18dd708

fix(feedback): address 3 self-review findings


KylinMountain May 17, 2026
dad19e5

docs(feedback): drop --print-url and --no-diagnostics, keep one flag


KylinMountain May 17, 2026

File filter

Filter by extension
Filter by extension
Conversations

Failed to load comments. 
Loading
Jump to

Jump to file


Failed to load files. 
Loading
 Diff view

 Diff view


1 change: 1 addition & 0 deletions
README.md

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -156,6 +156,7 @@ A single source might touch 10-15 wiki pages. Knowledge accumulates: each docume
| `openkb lint` | Run structural + knowledge health checks |
| `openkb list` | List indexed documents and concepts |
| `openkb status` | Show knowledge base stats |
| <code>openkb&nbsp;feedback&nbsp;["msg"]</code> | File feedback by opening a prefilled GitHub issue (use `--type bug/feature/question` to tag the issue) |

<!-- | `openkb lint --fix` | Auto-fix what it can | -->

Expand Down

151 changes: 151 additions & 0 deletions
openkb/cli.py

View file


Open in desktop

Original file line numberDiff line numberDiff line change
Expand Up@@ -1133,3 +1133,154 @@ def status(ctx):
 click.echo("No knowledge base found. Run `openkb init` first.")
 return
 print_status(kb_dir)


# ---------------------------------------------------------------------------
# feedback
# ---------------------------------------------------------------------------

_FEEDBACK_REPO = "VectifyAI/OpenKB"
_FEEDBACK_TYPES = ("bug", "feature", "question", "other")
_FEEDBACK_LABEL_MAP = {
 "bug": "bug",
 "feature": "enhancement",
 "question": "question",
 "other": "",
}


def _openkb_version() -> str:
 """Return the installed openkb package version.

 Delegates to ``openkb.__version__`` so the chat REPL, feedback issue
 body, and any future caller all surface the same fallback string
 (``0.0.0+unknown`` from ``openkb/__init__.py``). Mirrors
 ``openkb.agent.chat._openkb_version``.
 """
 from openkb import __version__
 return __version__


def _collect_feedback_diagnostics(ctx) -> dict[str, str]:
 """Auto-collect non-sensitive environment info to attach to a feedback
 issue. Kept deliberately small — no paths, no API keys, no usernames.
 """
 import platform

 kb_dir = _find_kb_dir(ctx.obj.get("kb_dir_override") if ctx.obj else None)
 return {
 "openkb": _openkb_version(),
 "python": platform.python_version(),
 "platform": f"{platform.system()} {platform.release()}",
 "kb_initialised": "yes" if kb_dir else "no",
 }


def _build_feedback_url(
 message: str, feedback_type: str, diagnostics: dict[str, str],
) -> str:
 """Build a GitHub issue URL with title / body / labels prefilled."""
 from urllib.parse import urlencode

 first_line = message.splitlines()[0] if message else ""
 truncated = first_line[:60] + ("…" if len(first_line) > 60 else "")
 title_prefix = f"[{feedback_type}] " if feedback_type != "other" else ""
 title = f"{title_prefix}{truncated}" if truncated else f"{title_prefix}Feedback from CLI"

 if diagnostics:
 diag_block = "\n".join(f"- **{k}**: {v}" for k, v in diagnostics.items())
 body = (
 f"{message}\n\n"
 "---\n\n"
 "<details>\n"
 "<summary>Diagnostics (auto-collected by <code>openkb feedback</code>)</summary>\n\n"
 f"{diag_block}\n"
 "</details>\n"
 )
 else:
 body = message

 params = {"title": title, "body": body}
 label = _FEEDBACK_LABEL_MAP.get(feedback_type, "")
 if label:
 params["labels"] = label

 return f"https://github.com/{_FEEDBACK_REPO}/issues/new?{urlencode(params)}"


@cli.command()
@click.argument("message", required=False)
@click.option(
 "--type", "feedback_type",
 type=click.Choice(_FEEDBACK_TYPES),
 default=None,
 help="Feedback type — sets the GitHub issue label.",
)
@click.pass_context
def feedback(ctx, message, feedback_type):
 """Submit feedback by opening a prefilled GitHub issue.

 Examples:

 \b
 openkb feedback # interactive
 openkb feedback "openkb add hangs on .docx" # one-line bug report
 openkb feedback --type feature "..." # tags the issue 'enhancement'

 The command does not send anything to OpenKB maintainers directly —
 it opens GitHub in your browser with title, body, and label prefilled.
 You log in with your own GitHub account and submit the issue.
 """
 if not message:
 click.echo(
 "What's your feedback? End with an empty line + Ctrl-D "
 "(Unix) or Ctrl-Z+Enter (Windows). Ctrl-C cancels."
 )
 message = sys.stdin.read().strip()

 if not message:
 click.echo("No feedback provided. Aborted.")
 ctx.exit(1)
 return

 if feedback_type is None:
 # Skip the prompt in non-TTY contexts (CI / piped stdin) so
 # ``echo "msg" | openkb feedback`` doesn't hang on the second
 # prompt after consuming all piped input for the message body.
 # Mirrors the ``_stdin_is_tty()`` gate added in PR #48.
 if _stdin_is_tty():
 feedback_type = click.prompt(
 "Type",
 default="other",
 type=click.Choice(_FEEDBACK_TYPES),
 show_default=True,
 show_choices=True,
 )
 else:
 feedback_type = "other"

 diagnostics = _collect_feedback_diagnostics(ctx)
 url = _build_feedback_url(message, feedback_type, diagnostics)

 click.echo("Copy this URL into a browser if the auto-open below fails:")
 click.echo(f" {url}")

 import webbrowser
 try:
 opened = webbrowser.open(url)
 except Exception as exc:
 # webbrowser.open rarely raises but be defensive — the printed URL
 # above is the fallback path.
 click.echo(f" (browser auto-open failed: {exc})", err=True)
 return

 # ``webbrowser.open`` returns False on headless boxes (no GUI, no
 # ``BROWSER`` env) without raising. Without this check we'd silently
 # print "Opened" and the user would think the issue was filed.
 if opened:
 click.echo("Opened GitHub in your browser.")
 else:
 click.echo(
 " (no browser available — copy the URL above to file the issue)",
 err=True,
 )
Loading