{"id":47885141,"url":"https://github.com/yuokada/hackmdio-java","last_synced_at":"2026-04-04T02:13:54.282Z","repository":{"id":338623109,"uuid":"1041750944","full_name":"yuokada/hackmdio-java","owner":"yuokada","description":null,"archived":false,"fork":false,"pushed_at":"2026-03-20T23:48:05.000Z","size":107,"stargazers_count":0,"open_issues_count":2,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2026-03-21T14:53:15.409Z","etag":null,"topics":["command-line-tool","hackmd","quarkus"],"latest_commit_sha":null,"homepage":"","language":"Java","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yuokada.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":"AGENTS.md","dco":null,"cla":null}},"created_at":"2025-08-21T00:43:55.000Z","updated_at":"2026-03-20T23:48:08.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/yuokada/hackmdio-java","commit_stats":null,"previous_names":["yuokada/hackmdio-java"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yuokada/hackmdio-java","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuokada%2Fhackmdio-java","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuokada%2Fhackmdio-java/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuokada%2Fhackmdio-java/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuokada%2Fhackmdio-java/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yuokada","download_url":"https://codeload.github.com/yuokada/hackmdio-java/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yuokada%2Fhackmdio-java/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31384905,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-04T01:22:39.193Z","status":"online","status_checked_at":"2026-04-04T02:00:07.569Z","response_time":60,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["command-line-tool","hackmd","quarkus"],"created_at":"2026-04-04T02:13:49.471Z","updated_at":"2026-04-04T02:13:54.267Z","avatar_url":"https://github.com/yuokada.png","language":"Java","readme":"# hackmdio-java\n\nA Java CLI tool for interacting with the [HackMD](https://hackmd.io/) API. It supports listing, creating, and retrieving notes, as well as offline full-text search powered by a local Couchbase Lite database.\n\nBuilt with Quarkus + Picocli and packaged as a standalone uber-jar.\n\n## Requirements\n\n- Java 17 or later\n- A HackMD account and API token\n\nSee [How to issue an API token](https://hackmd.io/@hackmd-api/developer-portal/https%3A%2F%2Fhackmd.io%2F%40hackmd-api%2Fhow-to-issue-an-api-token?utm_source=settings-api\u0026utm_medium=inline-cta) for token creation.\n\n- [Getting Started \\- HackMD](https://hackmd.io/@hackmd-api/developer-portal/https%3A%2F%2Fhackmd.io%2F%40hackmd-api%2FrkoVeBXkq?utm_source=settings-api\u0026utm_medium=inline-cta)\n- [Swagger UI](https://api.hackmd.io/v1/docs)\n\n## Setup\n\n```bash\n# Set your API token\nexport HACKMD_API_TOKEN=\"your-api-token\"\n\n# Build the uber-jar\n./mvnw package\n```\n\n## CLI Commands\n\n| Command  | Description |\n|----------|-------------|\n| `list`   | List notes from the HackMD API |\n| `create` | Create a new note |\n| `get`    | Retrieve a specific note by ID |\n| `open`   | Open a note's publish link in the default browser |\n| `index`  | Index notes to a local database for offline search |\n| `search` | Full-text search on locally indexed notes |\n\n### Usage Examples\n\n```bash\nJAR=target/hackmd-1.0.0-SNAPSHOT.jar\n\n# List all notes\njava -jar $JAR list\n\n# List notes in JSON format\njava -jar $JAR list --json\n\n# Create a new note\njava -jar $JAR create --title \"My Note\" --content \"Hello World\"\n\n# Get a specific note\njava -jar $JAR get \u003cnote-id\u003e\n\n# Open a note in the browser\njava -jar $JAR open \u003cnote-id\u003e\n\n# Index all notes to the local database\njava -jar $JAR index\n\n# Search the local database\njava -jar $JAR search \"search term\"\n\n# Search with JSON output\njava -jar $JAR search --json \"search term\"\n```\n\n### Index and Search Features\n\nThe `index` command synchronizes your HackMD notes to a local Couchbase Lite database, enabling offline search:\n\n- **Smart Sync**: Only downloads new or updated notes based on timestamps\n- **Rate-Limit Handling**: Automatic retry with exponential backoff on 429 responses\n- **Progress Tracking**: Shows real-time progress during indexing\n- **Summary Report**: Displays statistics about new, updated, and skipped notes\n\nThe `search` command performs full-text search on locally indexed notes:\n\n- **Fast Search**: Uses an FTS (Full-Text Search) index for quick results\n- **Offline**: Works without an internet connection after indexing\n- **Content Search**: Searches both title and content fields\n- **Snippet**: Shows context around matched terms in search results\n\n## Development\n\n```bash\n# Run in dev mode\n./mvnw quarkus:dev\n./mvnw quarkus:dev -Dquarkus.args='list --json'\n\n# Run tests\n./mvnw test\n\n# Checkstyle (Google Java Style)\n./mvnw checkstyle:check\n```\n\n## CI\n\nEvery push and pull request targeting `master` triggers the GitHub Actions workflow defined in `.github/workflows/ci.yml`, which sets up Temurin JDK 17 and runs `./mvnw -B test` to ensure the CLI continues to build and pass tests.\n\nDependency updates are monitored by Dependabot (`.github/dependabot.yml`), which opens weekly pull requests for Maven dependencies and GitHub Actions.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuokada%2Fhackmdio-java","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyuokada%2Fhackmdio-java","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyuokada%2Fhackmdio-java/lists"}