{"id":49303810,"url":"https://github.com/kryptic-sh/hjkl","last_synced_at":"2026-05-18T01:12:57.616Z","repository":{"id":353810962,"uuid":"1220995678","full_name":"kryptic-sh/hjkl","owner":"kryptic-sh","description":"Vim engine, rope buffer, and modal editor primitives. Pre-release; see MIGRATION.md.","archived":false,"fork":false,"pushed_at":"2026-05-11T16:51:08.000Z","size":2769,"stargazers_count":3,"open_issues_count":24,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-05-11T17:35:09.982Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://hjkl.kryptic.sh/","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kryptic-sh.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-04-25T16:05:01.000Z","updated_at":"2026-05-11T16:51:13.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/kryptic-sh/hjkl","commit_stats":null,"previous_names":["kryptic-sh/hjkl"],"tags_count":91,"template":false,"template_full_name":null,"purl":"pkg:github/kryptic-sh/hjkl","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kryptic-sh%2Fhjkl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kryptic-sh%2Fhjkl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kryptic-sh%2Fhjkl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kryptic-sh%2Fhjkl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kryptic-sh","download_url":"https://codeload.github.com/kryptic-sh/hjkl/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kryptic-sh%2Fhjkl/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32963191,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-12T23:30:32.555Z","status":"ssl_error","status_checked_at":"2026-05-12T23:30:18.191Z","response_time":102,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":[],"created_at":"2026-04-26T08:18:38.665Z","updated_at":"2026-05-18T01:12:57.611Z","avatar_url":"https://github.com/kryptic-sh.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hjkl\n\nVim engine, rope buffer, and modal editor primitives for building vim-modal\nterminal apps in Rust.\n\n[![CI](https://github.com/kryptic-sh/hjkl/actions/workflows/ci.yml/badge.svg)](https://github.com/kryptic-sh/hjkl/actions/workflows/ci.yml)\n[![crates.io](https://img.shields.io/crates/v/hjkl-engine.svg)](https://crates.io/crates/hjkl-engine)\n[![docs.rs](https://img.shields.io/docsrs/hjkl-engine)](https://docs.rs/hjkl-engine)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)\n[![Website](https://img.shields.io/badge/website-hjkl.kryptic.sh-7ee787)](https://hjkl.kryptic.sh)\n\nExtracted from [sqeel](https://github.com/kryptic-sh/sqeel) for reuse across\nsqeel, [buffr](https://github.com/kryptic-sh/buffr), and the standalone\n[`hjkl`](apps/hjkl) binary.\n\n## Status\n\n`0.12.2` — full LSP client (diagnostics, goto, hover, completion, code actions,\nrename, format), window splits, tabs, tmux-navigator handoff, mouse scroll, line\nnumbers, and a consumer-agnostic picker `PreviewHighlighter` trait. See\n[CHANGELOG.md](CHANGELOG.md) for the full release arc and\n[docs.rs/hjkl-engine](https://docs.rs/hjkl-engine) for the trait reference.\n\n## Crates\n\n| Crate            | Role                                                                                 |\n| ---------------- | ------------------------------------------------------------------------------------ |\n| `hjkl-engine`    | Vim FSM + grammar, traits, no I/O deps.                                              |\n| `hjkl-buffer`    | Rope-backed text buffer with cursor + edits + folds + search.                        |\n| `hjkl-editor`    | Front-door facade: re-exports engine + buffer + spec types.                          |\n| `hjkl-ratatui`   | Ratatui `Style` adapters and `crossterm::KeyEvent` bridge.                           |\n| `hjkl-clipboard` | In-house clipboard for the ecosystem (sync + async, OSC 52 SSH).                     |\n| `hjkl-form`      | Vim-modal forms with full vim grammar inside every text field.                       |\n| `hjkl-bonsai`    | Tree-sitter syntax highlighting; runtime `.so` grammars, Neovim-flavoured themes.    |\n| `hjkl-picker`    | Fuzzy picker subsystem: file walk, grep, custom sources, `PreviewHighlighter` trait. |\n| `hjkl-config`    | Shared TOML config loader: XDG paths, span errors, layered merge.                    |\n| `hjkl-splash`    | Startup splash screen widget (ratatui feature).                                      |\n| `hjkl-lsp`       | LSP client: per-language server lifecycle, full text-sync, diagnostics.              |\n\nPublished on crates.io. Add to `Cargo.toml`:\n\n```toml\nhjkl-editor = \"0.4\"\n```\n\n## Configuring `hjkl`\n\nThe standalone editor reads `$XDG_CONFIG_HOME/hjkl/config.toml` (Linux/macOS) or\n`%APPDATA%\\kryptic\\hjkl\\config\\config.toml` (Windows). Defaults are bundled into\nthe binary from [`apps/hjkl/src/config.toml`](apps/hjkl/src/config.toml) — that\nfile is the single source of truth for default values. The user file is\n**deep-merged** on top: only the fields you want to override need to appear\nthere. Unknown keys are an error.\n\nA custom path can be passed with `--config \u003cPATH\u003e`.\n\n```toml\n# ~/.config/hjkl/config.toml — minimal override example\n[editor]\nleader = \"\\\\\"\ntab_width = 2\n```\n\nSee [`apps/hjkl/src/config.toml`](apps/hjkl/src/config.toml) for the full schema\nwith comments.\n\n## Development\n\n```bash\ngit clone git@github.com:kryptic-sh/hjkl.git\ncd hjkl\nrustup toolchain install stable    # rust-toolchain.toml pins this for you\ncargo test --workspace\n```\n\nEach `hjkl-*` crate lives in its own submodule and ships independently to\ncrates.io. `#![deny(missing_docs)]` is enforced on `hjkl-engine` — new public\nAPI needs rustdoc.\n\nPerformance budgets are documented in [`MIGRATION.md`](MIGRATION.md). CI fails\nif a criterion bench regresses past budget.\n\n### Fuzzing\n\nThe only `cargo fuzz` target today is `hjkl-engine/fuzz :: handle_key` — feeds\nan arbitrary keystroke stream into a fresh `Editor` and asserts no panics. Local\nreproduction:\n\n```bash\ncd crates/hjkl-engine/fuzz\ncargo +nightly fuzz run handle_key\n```\n\n## Contributing\n\nSee the org-wide\n[CONTRIBUTING guide](https://github.com/kryptic-sh/.github/blob/main/.github/CONTRIBUTING.md)\nfor PR conventions, BCTP release flow, snapshot test workflow, and supported\nlanguage toolchains. Project-specific dev setup lives above in **Development**.\n\nFor security issues, see the org-wide\n[SECURITY policy](https://github.com/kryptic-sh/.github/blob/main/.github/SECURITY.md)\n— do not file public issues.\n\n## License\n\nMIT. See [LICENSE](LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkryptic-sh%2Fhjkl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkryptic-sh%2Fhjkl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkryptic-sh%2Fhjkl/lists"}