nerima-lisp/cl-nyancat

cl-nyancat

cl-nyancat is a Common Lisp terminal animation built on cl-tty-kit. It targets SBCL on x8664-linux and aarch64-darwin.

Full documentation is published at <https://nerima-lisp.github.io/cl-nyancat/. The source for that site lives in docs/src/.

Quick Start

(asdf:load-system "cl-nyancat")

(cl-nyancat:run :seed 42 :duration 10)
;; Fills the current terminal for ten seconds. Press q or Ctrl-C to quit
;; early, c to toggle color.

Or, once built, from the command line:

cl-nyancat --fps 24 --seed 42
cl-nyancat --frames 120 --no-counter
cl-nyancat -W 80 -H 24

The command-line interface is declared through cl-cli; see the usage guide for the full display, crop, and terminal-control option set.

Install

As a command, from a checkout:

nix build              # -> ./result/bin/cl-nyancat
./result/bin/cl-nyancat --duration 5

Or without cloning: nix run github:nerima-lisp/cl-nyancat.

As a library, from another flake:

# flake.nix
inputs.cl-nyancat = {
  url = "github:nerima-lisp/cl-nyancat/v0.1.0";
  inputs.nixpkgs.follows = "nixpkgs";
};

Pin a release tag rather than following the default branch. On a lispDependencies edge, read cl-nyancat.packages.<system.cl-nyancat -- packages.default is the delivered binary, not the ASDF system.

Documentation

• Getting started
• Usage and keybindings
• API reference
• Architecture
• Roadmap

Development