nekochef
Version, currently main branch1 version
- main branchlatestAug 28, 2023
github.com/mekanoe/nekochef
No description declared in shard.yml.
Installation
# Add this to your shard.yml
dependencies:
nekochef:
github: mekanoe/nekochef
branch: mainmain is a branch, not a release, so this tracks it rather than pinning a version.
Then run:
shards installshard.yml
- Crystal
- no constraint declared
- License
- MIT
Dependencies
Runtime Dependencies
- pluto*github: phenopolis/pluto
README
nekochef
Catgirls in your terminyal.
There is a high risk of NSFW content being displayed.
Supports terminals...
- [x] kitty
- [ ] iterm2
- [ ] others via w3m
Supports catgirl sources...
Configuration
Config can live as either a YAML file at ~/.config/nekochef/config.yml, $CONFIG_PATH, or as environment variables.
Translate YAML keys to environment variables by uppercasing and replacing . with _; e.g. gelbooru.use becomes GELBOORU_USE.
Booleans are true/1 or false/0.
Gelbooru Setup
- Go here: https://gelbooru.com/index.php?page=account&s=options
- Find "API Access Credentials"
- Set as
GELBOORU_API_AUTH=OR stuff in~/.config/nekochef/config.ymllike so:
gelbooru:
use: true
extra_params: -loli -furry
api_auth: "&api_key=aaaabbbccc&user_id=12345"
To lessen the chance of NSFW content, you may enable the "General Only Listing" setting in Gelbooru. It's not perfect.
Our default tag search is: cat_girl solo ${gelbooru.extra_params}. -- extra_params by default is -loli -furry.
Contributing
nekochef is a Crystal app that runs in one of the above terminal emulators.
You'll need:
- Crystal >=1.9
- Shards
- A supported terminal emulator or w3m installed
- An internet connection to your source of choice.
You can specify a CONFIG_PATH to not use your system config. I usually make a ./hack/config.yml.
Documentation
Built from the current release. The first visit to a release nobody has asked for starts its build.
Links
This branch
- Branch
main- Seen
- Aug 28, 2023
- Indexed
- yes
Dependents
No indexed shard depends on this one yet.
Repository
github.com/mekanoe/nekochef
Metadata
- Created
- Aug 12, 2026
- Updated
- Aug 15, 2026
- Synced
- Aug 15, 2026
- Versions
- 1