{"id":13478732,"url":"https://github.com/wfxr/code-minimap","last_synced_at":"2025-05-14T12:07:34.606Z","repository":{"id":37325370,"uuid":"298214010","full_name":"wfxr/code-minimap","owner":"wfxr","description":"🛰  A high performance code minimap render.","archived":false,"fork":false,"pushed_at":"2024-12-28T13:40:38.000Z","size":227,"stargazers_count":627,"open_issues_count":12,"forks_count":15,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-03-27T23:02:40.017Z","etag":null,"topics":["cli","minimap","terminal","thumbnail","tool","vim"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/wfxr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":"FUNDING.yml","license":"LICENSE-APACHE","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},"funding":{"ko_fi":"wfxr"}},"created_at":"2020-09-24T08:19:32.000Z","updated_at":"2025-03-14T02:26:16.000Z","dependencies_parsed_at":"2024-01-06T07:49:37.851Z","dependency_job_id":"4dc18987-604e-466a-b426-ffb93063fce5","html_url":"https://github.com/wfxr/code-minimap","commit_stats":{"total_commits":184,"total_committers":10,"mean_commits":18.4,"dds":0.4402173913043478,"last_synced_commit":"fe523790a82e55bf33fec30736902e2f12c2aa03"},"previous_names":[],"tags_count":22,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfxr%2Fcode-minimap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfxr%2Fcode-minimap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfxr%2Fcode-minimap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wfxr%2Fcode-minimap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wfxr","download_url":"https://codeload.github.com/wfxr/code-minimap/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247097983,"owners_count":20883128,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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":["cli","minimap","terminal","thumbnail","tool","vim"],"created_at":"2024-07-31T16:02:01.805Z","updated_at":"2025-04-04T00:02:46.259Z","avatar_url":"https://github.com/wfxr.png","language":"Rust","readme":"\u003ch1 align=\"center\"\u003e🛰 code-minimap\u003c/h1\u003e\n\u003cp align=\"center\"\u003e\n    \u003cem\u003eA high performance code minimap render.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://github.com/wfxr/code-minimap/actions?query=workflow%3ACICD\"\u003e\n        \u003cimg src=\"https://github.com/wfxr/code-minimap/workflows/CICD/badge.svg\" alt=\"CICD\"/\u003e\n    \u003c/a\u003e\n    \u003cimg src=\"https://img.shields.io/crates/l/code-minimap.svg\" alt=\"License\"/\u003e\n    \u003ca href=\"https://crates.io/crates/code-minimap\"\u003e\n        \u003cimg src=\"https://img.shields.io/crates/v/code-minimap.svg?colorB=319e8c\" alt=\"Version\"\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://github.com/wfxr/code-minimap/releases\"\u003e\n        \u003cimg src=\"https://img.shields.io/badge/platform-%20Linux%20|%20OSX%20|%20Win%20|%20ARM-orange.svg\" alt=\"Platform\"/\u003e\n    \u003c/a\u003e\n\u003c/p\u003e\n\nThis tool is for generating text minimaps at 🚀 speed.\nYou can use it to implement IDE-like minimap plugin for a terminal text editor,\n[minimap.vim](https://github.com/wfxr/minimap.vim) for example.\n\n### Features\n\n* Small and *fast* (see [benchmarks](#benchmark) below).\n* Memory efficient.\n* Freely zoom.\n* [Multi platforms](https://github.com/wfxr/code-minimap/releases) support.\n\n### Usage\n\n```\n$ code-minimap src/core.rs -H 0.6 -V 0.5\n⣿⣿⣿⣿⣿⠿⠛⠓⠒⠒⠂\n⣉⣿⣿⣿⣟⣛⣛⣛⠒⠒⠂\n⠀⠉⣿⣿⣿⣿⠭⠭⠭⠭⠤⠤⠤⠤⠤\n⠀⠉⠛⠻⢿⣿⣿⣿⣿⣶⣶⣶⣒⣒⣒⣒⣒⣒⣀⣀⣀⣀⣀⣀⣀⣀⣀⡀\n⠀⣀⣶⣾⣿⣿⣿⣿⣭⣭⣭⣤⣤⣤⣤⣤⠤⠤⠤⠤⠤\n⣿⣿⣿⣶⡒⠒⠒⠒\n⣿⣿⣶⣶⣶⣶⣶⣶⣤⣤⣤⣤⣤⣤⣤⣤⣄\n⣭⣭⣭⣭⠭⠭⠭⠭⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉⠉\n⣿⣿⣿⣿⣧⣤⣤⣤⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⡀\n⣛⣿⣿⣿⣟⣛⣒⣒⠂\n⣀⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣋⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⡀\n⠀⣤⣭⣽⣿⣷⣶⣶⣶⠶⠶⠶⠶⠶⠶⠶⠶⠶⠶⠶⠶⠒⠒⠒⠒⠒\n⠀⠶⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠿⠛⠓⠒⠒⠒⠒⠒\n⣉⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⣛⡛⠛⠛⠛⠛\n⠒⣶⣶⣶⣶⣶⣶⣶⣶⣶⣶⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⣤⡄\n⠀⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⡇\n⠄⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠛⠃\n```\n\nRun `code-minimap --help` to view detailed usage.\n\n### Installation\n\n#### On Linux\n\n##### Arch Linux\n`code-minimap` is available in the Arch User Repository. To install it from [AUR](https://aur.archlinux.org/packages/code-minimap):\n\n```\nyay -S code-minimap\n```\n\n##### Alpine Linux\n`code-minimap` is available in the [testing](https://pkgs.alpinelinux.org/packages?name=code-minimap\u0026branch=edge\u0026repo=testing) repository:\n\n```\napk add code-minimap\n```\n\n##### Gentoo\n`code-minimap` is available in the [GURU](https://github.com/gentoo/guru/) project repository:\n```\nemerge --ask code-minimap\n```\n\n\n#### On macOS\n\nYou can install `code-minimap` with Homebrew:\n\n```\nbrew install code-minimap\n```\n\nor with MacPorts:\n\n```\nsudo port install code-minimap\n```\n\n#### On Windows\n\nYou can install `code-minimap` with [scoop](https://github.com/lukesampson/scoop):\n\n```\nscoop bucket add extras\nscoop install code-minimap\n```\n\n#### From binaries\n\nPrebuilt versions of `code-minimap` for various architectures are available at [Github release page](https://github.com/wfxr/code-minimap/releases).\n\n*Note that you can try the `musl` version (which is statically-linked) if runs into dependency related errors.*\n\n#### From source\n\n`code-minimap` is also published on [crates.io](https://crates.io). If you have the latest Rust toolchains installed you can use `cargo` to install it from source:\n\n```\ncargo install --locked code-minimap\n```\n\nIf you want the latest version, clone this repository and run `cargo build --release`.\n\n### Benchmark\n\n- [src/core.rs](https://github.com/wfxr/code-minimap/blob/v0.3.0/src/core.rs):\n\n```\n$ hyperfine -w 10 'code-minimap src/core.rs'\nBenchmark #1: code-minimap src/core.rs\n  Time (mean ± σ):       0.2 ms ±   0.1 ms    [User: 0.4 ms, System: 0.3 ms]\n  Range (min … max):     0.2 ms …   1.1 ms    1560 runs\n```\n**79** lines, **4K** size, **0.2ms**.\n\n---------------------------------\n\n- [all rust code from rust-1.46.0](https://github.com/rust-lang/rust/archive/1.46.0.tar.gz):\n\n```\n$ fd -t f -e rs -x cat \"{}\" \u003e\u003e /tmp/all-in-one.rs\n$ hyperfine -w 10 'code-minimap /tmp/all-in-one.rs'\nBenchmark #1: code-minimap /tmp/all-in-one.rs\n  Time (mean ± σ):     322.7 ms ±   4.5 ms    [User: 298.7 ms, System: 23.8 ms]\n  Range (min … max):   318.5 ms … 334.1 ms    10 runs\n```\n**1,153,225** lines, **37M** size, **323ms**.\n\n---------------------------------\n\n- [huge random file]():\n```\n$ base64 /dev/urandom | head -10000000 \u003e huge.txt\n$ hyperfine -w 1 'code-minimap huge.txt'\nBenchmark #1: code-minimap huge.txt\n  Time (mean ± σ):      2.941 s ±  0.034 s    [User: 2.618 s, System: 0.321 s]\n  Range (min … max):    2.919 s …  3.028 s    10 runs\n\n```\n **10,000,000** lines, **735M** size, **2.9s**.\n\n---------------------------------\n\n*Test environment:*\n\n```\nBinary version: 0.3.0\nOS: Arch Linux x86_64\nKernel: 5.8.10-arch1-1\nCPU: Intel i9-9900K (16) @ 5.000GHz\n```\n\n### Related Project\n\n[minimap.vim](https://github.com/wfxr/minimap.vim): Blazing fast minimap for vim.\n\n### License\n\n`code-minimap` is distributed under the terms of both the MIT License and the Apache License 2.0.\n\nSee the [LICENSE-APACHE](LICENSE-APACHE) and [LICENSE-MIT](LICENSE-MIT) files for license details.\n","funding_links":["https://ko-fi.com/wfxr"],"categories":["Rust"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfxr%2Fcode-minimap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwfxr%2Fcode-minimap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwfxr%2Fcode-minimap/lists"}