{"id":33185909,"url":"https://github.com/akopdev/nbcat","last_synced_at":"2025-11-30T14:03:27.728Z","repository":{"id":289170339,"uuid":"970361778","full_name":"akopdev/nbcat","owner":"akopdev","description":"Preview Jupyter notebooks directly in your terminal. Think of it as cat, but for .ipynb files.","archived":false,"fork":false,"pushed_at":"2025-06-04T13:00:23.000Z","size":7484,"stargazers_count":30,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-09-20T18:23:50.134Z","etag":null,"topics":["ipynb","jupyter","jupyter-notebook","nbcat","terminal","tui"],"latest_commit_sha":null,"homepage":"","language":"Jupyter Notebook","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/akopdev.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,"zenodo":null}},"created_at":"2025-04-21T22:38:21.000Z","updated_at":"2025-08-26T10:26:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"da0bce09-4402-4bc9-8684-0bea6e5a6b1d","html_url":"https://github.com/akopdev/nbcat","commit_stats":null,"previous_names":["akopdev/nbcat"],"tags_count":13,"template":false,"template_full_name":null,"purl":"pkg:github/akopdev/nbcat","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akopdev%2Fnbcat","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akopdev%2Fnbcat/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akopdev%2Fnbcat/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akopdev%2Fnbcat/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/akopdev","download_url":"https://codeload.github.com/akopdev/nbcat/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/akopdev%2Fnbcat/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":27394204,"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","status":"online","status_checked_at":"2025-11-30T02:00:05.582Z","response_time":55,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["ipynb","jupyter","jupyter-notebook","nbcat","terminal","tui"],"created_at":"2025-11-16T05:00:20.104Z","updated_at":"2025-11-30T14:03:27.719Z","avatar_url":"https://github.com/akopdev.png","language":"Jupyter Notebook","readme":"\u003ch1 align=\"center\"\u003enbcat: Jupyter notebooks viewer\u003c/h1\u003e\n\n[nbcat](https://github.com/akopdev/nbcat) let you preview Jupyter notebooks directly in your terminal. Think of it as `cat`, but for `.ipynb` files.\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"docs/screenshot.png\" target=\"blank\"\u003e\u003cimg src=\"docs/screenshot.png\" width=\"400\" /\u003e\u003c/a\u003e\n  \u003ca href=\"docs/screenshot2.png\" target=\"blank\"\u003e\u003cimg src=\"docs/screenshot2.png\" width=\"400\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n## Features\n\n- Very fast and lightweight with minimal dependencies.\n- Preview remote notebooks without downloading them.\n- Enable paginated view mode with keyboard navigation (similar to `less`).\n- Supports image rendering in high resolution\n- Supports for all Jupyter notebook versions, including old legacy formats.\n\n## Motivation\n\nThe idea of previewing notebooks in a terminal is not new - there have been many previous attempts to achieve it.  \nHowever, most are either slow and overengineered with a ton of half-working features, or they're outdated and incompatible with modern Python.\n\nI was looking for a simple tool that let me quickly render Jupyter notebooks without switching context from my terminal window or installing a ton of dependencies.  \n\nPlease note, that `nbcat` doesn't aim to replace JupyterLab. If you need a full-featured terminal experience, I recommend checking out [euporie](https://euporie.readthedocs.io/) instead.\n\n\n## Installation\n\n```bash\n# Install from PyPI (recommended)\n$ pip install nbcat\n\n# Install via Homebrew\n$ brew tab akopdev/formulas/nbcat\n$ brew install --formula nbcat\n```\n\n## Quickstart\n\n```bash\n$ nbcat notebook.ipynb\n```\n\nYou can pass URLs as well.\n\n```bash\n$ nbcat https://raw.githubusercontent.com/akopdev/nbcat/refs/heads/main/tests/assets/test4.ipynb\n```\nIn most cases system `less` will render images in low resolution. Consider using an internal pager instead:\n\n```bash\n$ nbcat notebook.ipynb --page\n```\n## Integrations\n\n`nbcat` is designed to integrate seamlessly with other tools. Here are a few examples of how easily it can be done.\n\n### FZF (Fuzzy finder)\n\nList all `.ipynb` files and use `nbcat` to preview them:\n\n```bash\nfind . -type f -name \"*.ipynb\" | fzf --preview 'nbcat {}'\n```\n\n### Ranger\nTo enable previews in Ranger, add the `ipynb` extension to the `handle_extension` function in `~/.config/ranger/scope.sh`:\n\n```bash \n...\n\nhandle_extension() {\n    case \"${FILE_EXTENSION_LOWER}\" in\n        ipynb)\n            nbcat \"${FILE_PATH}\" \u0026\u0026 exit 5\n            exit 1;;\n        ...\n```\n\n## Testing \u0026 Development\n\nRun the tests:\n\n```bash\nmake test\n```\n\nCheck code quality:\n\n```bash\nmake format lint\n```\n\n## Contributing\n\nContributions are welcome! Please open an issue or [pull request](https://github.com/akopdev/nbcat/pulls).\n\n## License\n\nDistributed under the MIT License. See [`LICENSE`](./LICENSE) for more information.\n\n## Useful Links\n\n- 📘 Documentation: _coming soon_\n- 🐛 Issues: [GitHub Issues](https://github.com/akopdev/nbcat/issues)\n- 🚀 Releases: [GitHub Releases](https://github.com/akopdev/nbcat/releases)\n\n---\n\nMade with ❤️ by [Akop Kesheshyan](https://github.com/akopdev)\n","funding_links":[],"categories":["\u003ca name=\"viewers\"\u003e\u003c/a\u003eViewers"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakopdev%2Fnbcat","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fakopdev%2Fnbcat","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fakopdev%2Fnbcat/lists"}