{"id":21933276,"url":"https://github.com/codeyarduk/mordecai","last_synced_at":"2025-07-04T21:02:57.210Z","repository":{"id":258601736,"uuid":"873240211","full_name":"codeyarduk/mordecai","owner":"codeyarduk","description":"Mordecai is a CLI tool designed to link your local codebase with a remote workspace and synchronise file changes in real-time.","archived":false,"fork":false,"pushed_at":"2024-12-09T19:24:24.000Z","size":35411,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-01-27T12:49:43.368Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://mordecaiapp.com","language":"Go","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/codeyarduk.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}},"created_at":"2024-10-15T20:41:22.000Z","updated_at":"2024-12-09T19:23:52.000Z","dependencies_parsed_at":"2024-10-28T13:56:00.390Z","dependency_job_id":"7b3340ea-6a9d-415c-8fa2-7311e1425e25","html_url":"https://github.com/codeyarduk/mordecai","commit_stats":null,"previous_names":["codeyarduk/mordecai"],"tags_count":40,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeyarduk%2Fmordecai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeyarduk%2Fmordecai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeyarduk%2Fmordecai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/codeyarduk%2Fmordecai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/codeyarduk","download_url":"https://codeload.github.com/codeyarduk/mordecai/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244961220,"owners_count":20538941,"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","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-11-29T00:09:40.384Z","updated_at":"2025-03-22T13:25:02.223Z","avatar_url":"https://github.com/codeyarduk.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Mordecai CLI\n\nMordecai is a command-line interface (CLI) tool designed to link your local codebase with a remote workspace and synchronise file changes in real-time.\n\n## Installation\n\n### Brew\n\n```shell\nbrew tap codeyarduk/mordecai\n```\n\n```shell\nbrew install mordecai\n```\n\n### Curl\n\n**Install script**\n\n```shell\ncurl -sSL https://raw.githubusercontent.com/codeyarduk/mordecai/main/install.sh | bash\n```\n\n**Uninstall script**\n\n```shell\ncurl -sSL https://raw.githubusercontent.com/codeyarduk/mordecai/main/uninstall.sh | bash \n```\n\n## Usage\n\nThe basic syntax for using Mordecai is:\n\n```shell \nmordecai \u003ccommand\u003e\n```\n\n### Available Commands\n\n**link** \n\n```shell \nmordecai link\n```\n\nThis command:\n\n- Authenticates the user (if not already authenticated)\n- Reads the current directory\n- Prompts the user to select a remote workspace\n- Sends the initial codebase to the selected workspace\n- Starts watching the directory for changes and syncs them in real-time\n\n**logout**\n\n```shell\nmordecai logout\n```\n\nLogs out the current user by deleting the stored authentication token.\n\n**--help**\n\n```shell \nmordecai --help\n```\n\nDisplays usage information and available commands.\n\n**--version**\n\n```shell \nmordecai --version\n```\n\nDisplays the version of Mordecai you have got installed\n\n## About the tool\n\n**The basics**\n\n- Authentication: Uses a browser-based OAuth flow for secure user authentication.\n- Workspace Selection: Allows users to choose from available remote workspaces.\n- File Synchronization: Watches the local directory for changes and syncs them to the remote workspace.\n- Gitignore Support: Respects .gitignore rules when scanning directories.\n- File Type Filtering: Syncs only specific file types (e.g., .go, .js, .ts, .py, .html, .css, .json, .rb, .md).\n\n**Advanced Concepts**\n\n- Token Management: Securely stores and manages authentication tokens.\n- File System Watcher: Utilizes fsnotify for efficient file change detection.\n- Debounced Updates: Implements a 5-second debounce to batch file updates.\n- Interactive CLI: Uses charmbracelet/bubbles for an enhanced user interface.\n\n**Error Handling**\n\nThe CLI provides informative error messages for various scenarios, including authentication failures, file reading errors, and network issues.\n\n**Security Considerations**\n\n- Tokens are stored securely in the user's home directory.\n- HTTPS is used for all communications with the server.\n\n**Limitations**\n\n- Currently supports a predefined list of file extensions.\n- Requires an active internet connection for synchronization.\n\n\nFor more information or support, please contact [David on Twitter](https://x.com/davidwrossiter).\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeyarduk%2Fmordecai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcodeyarduk%2Fmordecai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcodeyarduk%2Fmordecai/lists"}