{"id":31689491,"url":"https://github.com/itcodehery/project_catport","last_synced_at":"2025-10-08T11:16:16.138Z","repository":{"id":309526385,"uuid":"1036568974","full_name":"itcodehery/Project_Catport","owner":"itcodehery","description":"A modern terminal-based file viewer with live sharing capabilities","archived":false,"fork":false,"pushed_at":"2025-09-09T11:58:11.000Z","size":155,"stargazers_count":1,"open_issues_count":1,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-09T14:38:46.207Z","etag":null,"topics":["cat","code","rust","sharing","viewer","websocket"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/itcodehery.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-08-12T09:10:31.000Z","updated_at":"2025-09-09T11:58:15.000Z","dependencies_parsed_at":"2025-08-12T12:14:10.650Z","dependency_job_id":"45adfa2b-9927-4658-8b5c-823798a8c024","html_url":"https://github.com/itcodehery/Project_Catport","commit_stats":null,"previous_names":["itcodehery/project_catport"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/itcodehery/Project_Catport","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcodehery%2FProject_Catport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcodehery%2FProject_Catport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcodehery%2FProject_Catport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcodehery%2FProject_Catport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/itcodehery","download_url":"https://codeload.github.com/itcodehery/Project_Catport/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/itcodehery%2FProject_Catport/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278931701,"owners_count":26070800,"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-10-08T02:00:06.501Z","response_time":56,"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":["cat","code","rust","sharing","viewer","websocket"],"created_at":"2025-10-08T11:16:14.112Z","updated_at":"2025-10-08T11:16:16.125Z","avatar_url":"https://github.com/itcodehery.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Catport Banner](./images/catport_banner.png)\r\n\r\n---\r\n\r\n# 🐾 Catport\r\n\r\n_A modern terminal-based file live sharing utility with file viewing capabilities_\r\n\r\n---\r\n\r\n## Features\r\n\r\n- **Syntax Highlighting**\r\n  Powered by [syntect](https://github.com/trishume/syntect), Catport makes your code easier to read and navigate.\r\n\r\n- **Real-time Live Share**\r\n  Instantly share files via **WebSockets** using [axum](https://github.com/tokio-rs/axum). Perfect for walkthroughs, code reviews, or lightweight pair programming.\r\n\r\n- **File Change Tracking**\r\n  With [notify](https://github.com/notify-rs/notify), Catport streams file changes live to connected viewers.\r\n\r\n- **Terminal-first Experience**\r\n  Simple, intuitive, and fast—just like `cat`, but supercharged.\r\n\r\n---\r\n\r\n## Cat → Bat → Catport\r\n\r\n- **`cat`** – View text files.\r\n- **`bat`** – Adds syntax highlighting and paging.\r\n- **`catport`** – Adds **real-time collaborative viewing** over the internet.\r\n\r\n---\r\n\r\n## Installation\r\n\r\n```bash\r\n# Clone the repo\r\ngit clone https://github.com/yourusername/catport.git\r\ncd catport\r\n\r\n# Build with Cargo\r\ncargo build --release\r\n\r\n# Run it\r\n./target/release/catport \u003ccommand\u003e \u003cfile\u003e\r\n```\r\n\r\n---\r\n\r\n## Commands\r\n\r\nCatport provides three main commands:\r\n\r\n### View\r\n\r\nView a file locally with syntax highlighting.\r\n\r\n```bash\r\ncatport view src/main.rs\r\n```\r\n\r\n### Share\r\n\r\nShare a file over WebSocket for others to view in real time.\r\n\r\n```bash\r\ncatport share src/lib.rs\r\n```\r\n\r\nThis will print a **shareable link** that others can use to connect.\r\n\r\n### Connect\r\n\r\nConnect to a shared file session and track updates live.\r\n\r\n```bash\r\ncatport connect http://localhost:3000/share/\u003cid\u003e\r\n```\r\n\r\n---\r\n\r\n## Built With\r\n\r\n- [Rust](https://www.rust-lang.org/) – safe, fast, and concurrent\r\n- [Axum](https://github.com/tokio-rs/axum) – for WebSocket-powered sharing\r\n- [Syntect](https://github.com/trishume/syntect) – syntax highlighting\r\n- [Notify](https://github.com/notify-rs/notify) – file watching\r\n\r\n---\r\n\r\n## Roadmap\r\n\r\n- [✅] Finishing Implementation for Viewing and Syntax Highlighting\r\n- [✅] Finishing Implementations for Sharing\r\n- [ ] Finishing Implementation for Connecting via Terminal\r\n- [ ] Global Installation Implementation (PATH)\r\n- [ ] Two-way collaborative editing\r\n- [ ] Role-based permissions for viewers\r\n- [ ] Editor/IDE plugins\r\n\r\n---\r\n\r\n## Contributing\r\n\r\nI'm building Catport as an **open-source community project**. Contributions are welcome!\r\n\r\n1. Fork the repo\r\n2. Create a feature branch\r\n3. Commit your changes\r\n4. Push and open a Pull Request\r\n\r\nCheck out the [Issues](./issues) page for things to work on.\r\n\r\n---\r\n\r\n**Catport** – _from viewing, to highlighting, to sharing._\r\n\r\n---\r\n\r\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcodehery%2Fproject_catport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fitcodehery%2Fproject_catport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fitcodehery%2Fproject_catport/lists"}