{"id":15116859,"url":"https://github.com/guilhermeprokisch/see","last_synced_at":"2025-09-27T22:31:24.752Z","repository":{"id":255250752,"uuid":"849028070","full_name":"guilhermeprokisch/see","owner":"guilhermeprokisch","description":"A cute cat(1) for the terminal with advanced code viewing, Markdown rendering, 🌳  tree-sitter syntax highlighting, images view and more.","archived":false,"fork":false,"pushed_at":"2025-05-05T10:30:34.000Z","size":339,"stargazers_count":248,"open_issues_count":10,"forks_count":5,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-09-23T16:43:04.951Z","etag":null,"topics":[],"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/guilhermeprokisch.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","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":"2024-08-28T21:02:45.000Z","updated_at":"2025-09-15T08:35:42.000Z","dependencies_parsed_at":null,"dependency_job_id":"dbd90c0a-60d3-4e7e-8161-5ab326d59982","html_url":"https://github.com/guilhermeprokisch/see","commit_stats":null,"previous_names":["guilhermeprokisch/smd","guilhermeprokisch/see"],"tags_count":28,"template":false,"template_full_name":null,"purl":"pkg:github/guilhermeprokisch/see","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guilhermeprokisch%2Fsee","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guilhermeprokisch%2Fsee/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guilhermeprokisch%2Fsee/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guilhermeprokisch%2Fsee/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/guilhermeprokisch","download_url":"https://codeload.github.com/guilhermeprokisch/see/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/guilhermeprokisch%2Fsee/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":277302072,"owners_count":25795357,"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-09-27T02:00:08.978Z","response_time":73,"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":[],"created_at":"2024-09-26T01:45:21.703Z","updated_at":"2025-09-27T22:31:24.493Z","avatar_url":"https://github.com/guilhermeprokisch.png","language":"Rust","funding_links":[],"categories":["Rust","\u003ca name=\"viewers\"\u003e\u003c/a\u003eViewers","CLI/TUI Apps","Others"],"sub_categories":["Other"],"readme":"# see - See a cute cat.\n\n\u003e cat you see!? It's a fancy cat! :cat:\n\n\u003cimg width=\"1363\" alt=\"image\" src=\"https://github.com/user-attachments/assets/bd253204-deca-4756-bbba-60272e0a367c\"\u003e\n\nMarkdown it's special 🐈\n\n\u003cimg width=\"1363\" alt=\"image\" src=\"https://github.com/user-attachments/assets/b4c3c3ef-8ba5-4ab5-8a3d-55556ca02536\"\u003e\n\n\nImages 🖼️ 📷 and more..\n\nhttps://github.com/user-attachments/assets/8ee492e9-950c-4dcd-a96f-62756b97fe25\n\n\n\u003e [!WARNING]  \n\u003e This project is currently in alpha stage. It may contain bugs, incomplete features, or undergo significant changes. Use with caution and please report any issues you encounter.\\*\\*\n\nsee is a powerful file visualization tool for the terminal, offering advanced code viewing capabilities, Markdown rendering, and more. It provides syntax highlighting, emoji support, and image rendering capabilities, offering a visually appealing way to view various file types directly in your console.\n\n## Features\n\n- State-of-the-art code viewing capabilities with superior syntax highlighting for a wide range of programming languages, powered by tree-sitter\n- More accurate, context-aware syntax highlighting\n- Minimalistic rich Markdown rendering in the terminal\n- Emoji support :smile:\n- Image rendering (when possible)\n- Clickable links (in supported terminals)\n- Table formatting\n- Blockquote styling\n- And more coming soon!\n\n# Motivation and Context\n\nThe primary goal of **see** _(smd before v0.4.0)_ was to create a unified tool for viewing both CLI documentation in Markdown and code files, renderable in both the terminal and web browse\n\nAs the project evolved from its initial focus on Markdown, support for viewing code files was added, expanding its utility in diverse development ecosystems. Now, see is your go-to tool for seeing everything that a cat can see!\n\n## Markdown Capabilities\n\nWhile see has expanded its focus beyond just Markdown, it still offers robust Markdown rendering capabilities:\n\n- Rich text formatting (bold, italic, strikethrough)\n- Headers and lists\n- Code blocks with syntax highlighting\n- Tables\n- Blockquotes\n- Images (when supported by the terminal)\n- Clickable links\n\n## Usage\n\n### 1. Viewing Code Files\n\nsee serves as a powerful code viewer for the terminal, providing an efficient way to review code directly in your console with advanced syntax highlighting:\n\n```bash\nsee path/to/your/code_file.py\nsee --line-numbers path/to/your/code_file.py  # with line numbers\n```\n\n### 2. Rendering Markdown Files\n\nTo render a Markdown file, simply pass the path to the file as an argument:\n\n```bash\nsee path/to/your/markdown_file.md\n```\n\n### 3. Rendering Markdown from Piped Input\n\nsee can also read Markdown content from standard input:\n\n```bash\necho \"# Hello, *world*\" | see\ncat README.md | see  # Render a file's content\ncurl -sL https://raw.githubusercontent.com/guilhermeprokisch/see/master/README.md | see  # Render a remote Markdown file\n```\n\n## Installation\n\nThere are several ways to install see:\n\n### 1. Install prebuilt binaries via shell script (Recommended)\n\nThe easiest and fastest way to install see is by using our shell script:\n\n\u003e [!IMPORTANT]  \n\u003e The version number in the URL bellow (v0.8.0) may not be the latest version. Please check the [releases page](https://github.com/guilhermeprokisch/see/releases) for the most recent version and update the URL accordingly before running the command.\\*\\*\n\n```sh\ncurl --proto '=https' --tlsv1.2 -LsSf https://github.com/guilhermeprokisch/see/releases/download/v0.8.0/see-cat-installer.sh | sh\n```\n\n### 2. Using prebuilt binaries from GitHub releases\n\nIf you prefer to manually download and install the binary:\n\n1. Visit the [see releases page](https://github.com/guilhermeprokisch/see/releases) on GitHub.\n2. Find the latest release version.\n3. Download the appropriate binary for your operating system and architecture.\n4. Extract the downloaded file if necessary.\n5. Move the `see` binary to a directory in your system's PATH (e.g., `/usr/local/bin` on Unix-like systems).\n\n### 3. Install prebuilt binaries via Homebrew\n\nIf you're using Homebrew, you can install see with:\n\n```sh\nbrew install guilhermeprokisch/see/see\n```\n\n### 4. Using Cargo\n\nYou can install see directly from crates.io using Cargo:\n\n```bash\ncargo install see-cat\n```\n\nThis will download, compile, and install the latest version of see. Make sure your Rust installation is up to date.\n\n### 5. Building from Source\n\nIf you prefer to build from source or want to contribute to the project:\n\n1. Ensure you have Rust and Cargo installed. If not, get them from [https://rustup.rs/](https://rustup.rs/).\n\n2. Clone the repository:\n\n   ```bash\n   git clone https://github.com/guilhermeprokisch/see.git\n   cd see\n   ```\n\n3. Build and install the project using Cargo:\n\n   ```bash\n   cargo install --path .\n   ```\n\nThis will compile the project and install the `see` binary in your Cargo bin directory, which should be in your PATH.\n\n#### Integration with CLI Tools\n\nsee can be easily integrated with CLI tools to replace traditional man pages with rich Markdown documentation. Here's an example of how you can use see with a custom CLI tool's --help flag:\n\n```bash\n#!/bin/bash\n\n# Name: mycli\n# Description: Example CLI tool using see for documentation\n\nif [[ \"$1\" == \"--help\" ]]; then\n    # Use see to render the Markdown help file\n    see ~/.mycli/help.md\nelse\n    # Regular CLI functionality\n    echo \"Running mycli with arguments: $@\"\nfi\n```\n\nIn this example, create a Markdown file at `~/.mycli/help.md` with your CLI documentation. When users run `mycli --help`, they'll see a beautifully rendered version of your Markdown documentation instead of a plain text man page.\n\n\u003cimg width=\"1482\" alt=\"image\" src=\"https://github.com/user-attachments/assets/9b97388e-64d6-4d48-b1a8-614a209f32ee\"\u003e\n\nThis approach allows you to maintain a single source of documentation that's readable in raw form, rendered nicely in the terminal, and viewable in web browsers.\n\n#### Viewing see's Own Documentation\n\nsee uses itself to display its own documentation. You can view see's documentation directly in your terminal by running:\n\n```bash\nsee --help\n```\n\nThis command will render see's main documentation file `/docs`, giving you a practical example of see in action and providing detailed information about its usage and features.\n\n## Configuration\n\nsee supports user-defined configuration files. You can customize various aspects of the rendering process by creating a `config.toml` file in the following location:\n\n- On Linux and macOS: `~/.config/see/config.toml`\n- On Windows: `C:\\Users\\\u003cUSERNAME\u003e\\AppData\\Roaming\\see\\config.toml`\n\nYou can generate a default configuration file by running:\n\n```bash\nsee --generate-config\n```\n\nHere's an example of what you can configure:\n\n```toml\nmax_image_width = 40\nmax_image_height = 13\nrender_images = true\nrender_links = true\nrender_table_borders = false\nshow_line_numbers = true\n```\n\n- `max_image_width` and `max_image_height`: Maximum dimensions for rendered images\n- `render_images`: If false, images will not be rendered\n- `render_links`: If false, links will not be clickable\n- `render_table_borders`: If true, tables will be rendered with ASCII borders (default: false)\n- `show_line_numbers`: If true, line numbers will be shown for code files (can also be set with `--line-numbers` option)\n\nNote: see uses [tree-sitter](https://github.com/tree-sitter/tree-sitter) thanks to [inkjet](https://github.com/Colonial-Dev/inkjet) for syntax highlighting. Currently, only one theme is implemented, but there are plans to make see compatible with Helix editor themes in the future, which will greatly expand customization options.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request. As this project is in alpha, your input and contributions can significantly shape its development.\n\n## Known Issues\n\nAs this is an alpha version, you may encounter bugs or incomplete features.\n\n## License\n\nThis project is licensed under the MIT License. See the [LICENSE](LICENSE) file for details.\n\n## TODO:\n\n1. Extended Markdown Support\n\n2. Improve syntax highlighting\n\n3. Theming and Customization: Develop user-customizable color schemes and rendering options\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermeprokisch%2Fsee","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fguilhermeprokisch%2Fsee","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fguilhermeprokisch%2Fsee/lists"}