{"id":13822387,"url":"https://github.com/Avarel/mini-me","last_synced_at":"2025-05-16T15:34:14.318Z","repository":{"id":57638880,"uuid":"185086429","full_name":"Avarel/mini-me","owner":"Avarel","description":"Inline multiline text-editor/prompt written in Rust.","archived":false,"fork":false,"pushed_at":"2023-12-17T11:41:13.000Z","size":159,"stargazers_count":26,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-09-20T09:13:01.728Z","etag":null,"topics":["console","crossterm","editor","multiline","rust-lang"],"latest_commit_sha":null,"homepage":"","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/Avarel.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2019-05-05T21:58:38.000Z","updated_at":"2024-06-08T07:35:43.000Z","dependencies_parsed_at":"2023-12-17T12:40:35.088Z","dependency_job_id":null,"html_url":"https://github.com/Avarel/mini-me","commit_stats":{"total_commits":77,"total_committers":1,"mean_commits":77.0,"dds":0.0,"last_synced_commit":"bb534a106099ca1f9695e4a7eb88ce1a9e2375c7"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Avarel%2Fmini-me","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Avarel%2Fmini-me/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Avarel%2Fmini-me/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Avarel%2Fmini-me/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Avarel","download_url":"https://codeload.github.com/Avarel/mini-me/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225436685,"owners_count":17474196,"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":["console","crossterm","editor","multiline","rust-lang"],"created_at":"2024-08-04T08:01:58.277Z","updated_at":"2024-11-19T22:33:05.815Z","avatar_url":"https://github.com/Avarel.png","language":"Rust","funding_links":[],"categories":["Rust"],"sub_categories":[],"readme":"# Mini-Me\nAn embeddable, customizable, inline text-editor based on `crossterm`.\n```rust\n      ╭─── Input Prompt\n    1 │ hello there\n    2 │ this is a simple prompt\n    3 │ thats multiline and decent enough\n    4 ┃ _\n      ╰─── Lines: 4     Chars: 70    Ln: 3, Col: 0\n```\n\n## Features\n* Simple, intuitive, and embeddable.\n* Customize header, footer, and or margin gutters.\n    * Preset styles are unstable.\n* Range selection.\n* Toggle-able fullscreen mode.\n* (Unstable) Clipboard support.\n\n## Binary Installation\n`minime` can be used as a CLI. The best way to install it is using:\n```bash\ncargo install --features=bin --path .\n```\nThe binary can be used by invoking `minime -h`.\n\n## Default Controls\n* Arrow keys work as expected.\n* Home, end, delete, Tab and backtab mirrors VSCode behavior.\n* F12 to enter full screen mode.\n* Shift-arrow keys create a selection range.\n* `Esc` or `Enter` on the last empty line to close and submit the prompt.\n* Control-X/C/V clipboard support is unstable.\n\n## Usage\n\n### Basic Setup\nThis is the most basic setup available.\n```rust\nuse minime::{editor::keybindings::NormalKeybinding, editor::Editor, Result};\n\nfn main() -\u003e Result\u003c()\u003e {\n    println!(\"Write something cool!\");\n    // Build the prompt.\n    let mut term = Editor::default();\n    term.read(NormalKeybinding, DefaultRenderer::default())?;\n    dbg!(term.contents());\n    Ok(())\n}\n```\n\n### Advanced\nYou can lock `stdout()` or `stderr()` to get better performance. You can also\ncustomize several settings in the renderer.\n```rust\nuse minime::{\n    editor::{keybindings::NormalKeybinding, Editor},\n    renderer::{\n        full::CrosstermRenderer,\n        styles::classic::{ClassicFooter, ClassicGutter, ClassicHeader},\n    },\n    Result,\n};\n\nfn main() -\u003e Result\u003c()\u003e {\n    // Redirect our output to stdout (default).\n    let stdout = std::io::stdout();\n    let mut lock = stdout.lock();\n\n    let renderer = CrosstermRenderer::render_to(\u0026mut lock)\n        .max_height(Some(10))\n        .margin(ClassicGutter)\n        .header(ClassicHeader {\n            message: \"Enter on the last line or Esc to submit your input!\",\n        })\n        .footer(ClassicFooter);\n\n    // Print out some prompt using styling options.\n    let term = Editor::with_renderer(renderer);\n    let result = term.read(NormalKeybinding)?;\n    dbg!(result);\n    Ok(())\n}\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAvarel%2Fmini-me","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FAvarel%2Fmini-me","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FAvarel%2Fmini-me/lists"}