{"id":13752417,"url":"https://github.com/yannjor/krabby","last_synced_at":"2025-07-27T16:32:57.901Z","repository":{"id":42122892,"uuid":"479976429","full_name":"yannjor/krabby","owner":"yannjor","description":"Print pokemon sprites in your terminal","archived":false,"fork":false,"pushed_at":"2023-11-12T14:01:49.000Z","size":4452,"stargazers_count":70,"open_issues_count":2,"forks_count":2,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-04-14T05:09:54.094Z","etag":null,"topics":["cli","pokemon","rust","terminal"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yannjor.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":"2022-04-10T09:56:00.000Z","updated_at":"2024-06-13T04:55:09.475Z","dependencies_parsed_at":"2024-06-13T05:07:44.819Z","dependency_job_id":null,"html_url":"https://github.com/yannjor/krabby","commit_stats":{"total_commits":32,"total_committers":3,"mean_commits":"10.666666666666666","dds":0.15625,"last_synced_commit":"dcf2714a01f40af8c8ab2a52deb0abedc0add340"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yannjor%2Fkrabby","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yannjor%2Fkrabby/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yannjor%2Fkrabby/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yannjor%2Fkrabby/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yannjor","download_url":"https://codeload.github.com/yannjor/krabby/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227817012,"owners_count":17824200,"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","pokemon","rust","terminal"],"created_at":"2024-08-03T09:01:05.503Z","updated_at":"2025-07-27T16:32:57.895Z","avatar_url":"https://github.com/yannjor.png","language":"Rust","funding_links":[],"categories":["Terminal"],"sub_categories":["Fancies"],"readme":"# krabby\n\n![Crates.io version](https://img.shields.io/crates/v/krabby)\n![AUR version](https://img.shields.io/aur/version/krabby-bin)\n\nKrabby is mostly a Rust rewrite of phoney badger's [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts)\nwith some extra features.\n\n![](https://i.imgur.com/MVzaS3k.png)\n\n## Table of contents\n* [Features](#features)\n* [Installation](#installation)\n  * [Arch Linux x86_64 (and derivatives)](#arch-linux-x86_64-and-derivatives)\n  * [Ubuntu/Debian x86_64 (and derivatives)](#ubuntudebian-x86_64-and-derivatives)\n  * [Installing from source (other distros and MacOS/Windows)](#installing-from-source-other-distros-and-macoswindows)\n* [Usage](#usage)\n  * [Examples](#examples)\n* [Configuration](#configuration)\n* [Credits](#credits)\n* [Similar projects](#similar-projects)\n\n\n## Features\n- Pokemon from every generation, including shinies, megas, gigantamax, and regional variants\n- Print random pokemon (with filters for generations and different forms)\n- Print pokemon by name\n- Print pokedex entry together with the sprite\n- Configuration file, right now only for language and shiny rate\n\n## Installation\n\n### Arch Linux x86_64 (and derivatives)\n\nFrom the AUR using your favorite AUR helper\n\n```\nyay -S krabby-bin\n```\n\nOr alternatively you can manually download the PKGBUILD file from the repository, then run\n```\nmakepkg -si\n```\n\nThere is also the development package [krabby-git](https://aur.archlinux.org/packages/krabby-git) that tracks the main branch.\n\n### Ubuntu/Debian x86_64 (and derivatives)\n\nDownload the latest `.deb` release. Then run (replacing v.v.v with the version number)\n```\ndpkg -i krabby_v.v.v_amd64.deb\n```\n\n### Homebrew\n\nAdd the tap:\n```\nbrew tap yannjor/krabby\n```\n\nInstall:\n```\nbrew install krabby\n```\n\n### Installing from source (other distros and MacOS/Windows)\n\nTo install krabby from source, you will need Rust. Installation instructions can be found [here](https://www.rust-lang.org/learn/get-started).\n\nNow using cargo, run\n```\ncargo install krabby\n```\nMake sure you have `.cargo/bin` added to your shell `PATH`. This can be done by adding the following to your `.profile`, `.bash_profile` or `.zprofile`\n```sh\nexport PATH=\"$PATH:$HOME/.cargo/bin\"\n```\n\n## Usage\nRun the help command `krabby help` to see the following help message.\n\n```\nUSAGE:\n    krabby \u003cSUBCOMMAND\u003e\n\nOPTIONS:\n    -h, --help       Print help information\n    -V, --version    Print version information\n\nSUBCOMMANDS:\n    help      Print this message or the help of the given subcommand(s)\n    list      Print list of all pokemon. This command can optionally be followed by a generation\n                  number or range (1-9) to show pokemon from a specific generation or range of\n                  generations. The generations can be provided as a continuous range (eg. 1-3) or\n                  as a list of generations (1,3,6)\n    name      Select pokemon by name. Generally spelled like in the games. A few exceptions are\n                  nidoran-f, nidoran-m, mr-mime, farfetchd, flabebe type-null etc. Perhaps grep the\n                  output of list if in doubt\n    random    Show a random pokemon. This command can optionally be followed by a generation\n                  number or range (1-9) to show random pokemon from a specific generation or range\n                  of generations. The generations can be provided as a continuous range (eg. 1-3) or\n                  as a list of generations (1,3,6)\n```\nTo get more detailed information about a subcommand you can also view its help, for example\n```\nkrabby help random\n```\nTo get the help of the random subcommand.\n\n### Examples\nPrint a specific pokemon\n```\nkrabby name charizard\n```\nPrint a specific shiny pokemon\n```\nkrabby name spheal -s\n```\nPrint a specific pokemon together with its pokedex entry\n```\nkrabby name mudkip -i\n```\nPrint an alternative form of a pokemon\n```\nkrabby name blastoise -f mega\n```\nPrint a random pokemon (gens 1-9)\n```\nkrabby random\n```\nPrint random pokemon from generations 1-3\n```\nkrabby random 1-3\n```\nPrint a random pokemon from generations 1,3 and 6\n```\nkrabby random 1,3,6\n```\nPrint a random pokemon excluding megas, gigantamax and regional variants\n```\nkrabby random --no-mega --no-gmax --no-regional\n```\nPrint a random pokemon excluding all variants (like above, including one-offs like `primal`)\n```\nkrabby random --no-variant\n```\n\n## Configuration\nWhen the program is run, a TOML config file will automatically be created in the user's config\ndirectory (usually `~/.config`) under `krabby/config.toml` if it doesn't exist already.\n\nOn MacOS the config will be in: `/Users/\u003cusername\u003e/Library/Application Support/krabby`\nOn Windows this will be: `C:\\Users\\\u003cusername\u003e\\AppData\\Roaming\\krabby`\n\n```toml\n# The language to use when printing the pokemon's name and/or description.\n# Possible options include en (English), fr (French), de (German), ja (Japanese),\n# zh_hans (Chinese with simplified characters), zh_hant (Chinese with traditional characters)\nlanguage = 'en'\n\n# The probability to show a shiny pokemon when using the random command\nshiny_rate = 0.0078125\n```\n\n## Credits\nThe pokemon sprites for krabby were generated using sprites from [PokéSprite](https://msikma.github.io/pokesprite/)\nand converted to unicode using Phoney Badger's [pokemon-generator-scripts](https://gitlab.com/phoneybadger/pokemon-generator-scripts).\nThe pokemon data was obtained from [PokéAPI](https://github.com/PokeAPI/pokeapi).\n\n\n## Similar projects\n- [pokemon-colorscripts](https://gitlab.com/phoneybadger/pokemon-colorscripts)\n- [pokeget](https://github.com/talwat/pokeget)\n- [pokeshell](https://github.com/acxz/pokeshell)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyannjor%2Fkrabby","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyannjor%2Fkrabby","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyannjor%2Fkrabby/lists"}