Skip to content

Document shared database URLs as JabKit input - #686

Open
koppor wants to merge 1 commit into
mainfrom
jabkit-shared-db
Open

koppor wants to merge 1 commit into
mainfrom
jabkit-shared-db

Conversation

@koppor

@koppor koppor commented Sep 8, 2026

Copy link
Copy Markdown
Member

Pull Request Description

Summary

Adds an "Input sources" section to the JabKit page: wherever a command takes an input file, a URL or the connection URL of a shared SQL library can be passed instead.

Steps to test

Check the preview link in this PR, go to the JabKit page, section "Input sources", and follow the example against a shared SQL library.

Related issues and pull requests

Documents JabRef/jabref#16970

AI usage

Claude Code (model claude-opus-5), AIL3: text written by the AI; reviewed by me.

Checklist

  • I reviewed and take ownership of all content in this PR, including any AI-assisted text
  • I opened JabRef and followed these instructions myself to confirm they still work (tested on version: 6.0-alpha6)
  • Any links I added or changed work (no 404s)
  • [/] Any images or tables I added display correctly
  • I checked spelling/grammar

🤖 Generated with Claude Code

https://claude.ai/code/session_01CaMTBRfjP8gEHzbiFYLkCf

Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01CaMTBRfjP8gEHzbiFYLkCf
@qodo-free-for-open-source-projects

Copy link
Copy Markdown

Code Review by Qodo

🐞 Bugs (0) 📘 Rule violations (0) 📎 Requirement gaps (0)

Grey Divider

Great, no issues found!

Qodo reviewed your code and found no material issues that require review

Grey Divider

Tip of the day
💡 Did you know, you can tweak Display preferences with a live preview to see your comment before it ships

More tips ↗ | Customize Qodo ↗ | Qodo docs ↗

Grey Divider

Qodo Logo

@qodo-free-for-open-source-projects

Copy link
Copy Markdown

PR Summary by Qodo

Document URL and shared database inputs for JabKit

📝 Documentation 🕐 Less than 5 minutes

Grey Divider

AI Description

• Documents local files, remote URLs, and shared PostgreSQL libraries as JabKit inputs.
• Adds a conversion example and clarifies read-only behavior, quoting, and credential-history risks.
Diagram

graph TD
  U["CLI User"] --> S{"Input Source"} -->|Local| L["Input File"] --> J["JabKit Command"] --> O["Output File"]
  S -->|HTTP or FTP| R["Remote URL"] --> J
  S -->|PostgreSQL| D["Shared Library"] --> J
Loading
High-Level Assessment

A dedicated input-sources section beside the general command documentation is the clearest approach because the behavior applies across commands. Repeating this guidance under every command would create duplication and increase maintenance risk.

Files changed (1) +11 / -0

Documentation (1) +11 / -0
jabkit.mdDocument supported JabKit URL and database inputs +11/-0

Document supported JabKit URL and database inputs

• Adds an Input sources section explaining that JabKit accepts HTTP(S), FTP, and shared PostgreSQL library URLs wherever an input file is supported. Includes a conversion example and warns about read-only database handling, shell quoting, and passwords stored in shell history.

en/jabkit.md

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant