{"id":13561953,"url":"https://github.com/MisterTea/CodeFS","last_synced_at":"2025-04-03T17:32:06.386Z","repository":{"id":76895872,"uuid":"136413461","full_name":"MisterTea/CodeFS","owner":"MisterTea","description":"Meta-Filesystem for remote software development","archived":false,"fork":false,"pushed_at":"2020-03-13T05:12:52.000Z","size":2154,"stargazers_count":20,"open_issues_count":1,"forks_count":1,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-04-03T07:51:19.731Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"C++","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/MisterTea.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}},"created_at":"2018-06-07T02:53:26.000Z","updated_at":"2025-03-10T04:18:08.000Z","dependencies_parsed_at":"2023-06-25T22:21:15.386Z","dependency_job_id":null,"html_url":"https://github.com/MisterTea/CodeFS","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MisterTea%2FCodeFS","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MisterTea%2FCodeFS/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MisterTea%2FCodeFS/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/MisterTea%2FCodeFS/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/MisterTea","download_url":"https://codeload.github.com/MisterTea/CodeFS/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247047140,"owners_count":20874781,"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-08-01T13:01:02.975Z","updated_at":"2025-04-03T17:32:01.374Z","avatar_url":"https://github.com/MisterTea.png","language":"C++","readme":"# CodeFS\nCodeFS is a filesystem for remote software development.\n\n# Why make CodeFS?\n\nRemote development is a key component of software engineering.  Whether developing for embedded devices or building large ML pipelines in the cloud, one often finds oneself needing to work jointly on a local laptop and on a desktop, embedded device, or virtual server.\n\nThere are already several approaches for this, here is a breakdown of their pros and cons:\n\n| Tool                          | Pros                    | Cons                               |\n| ----------------------------- | ----------------------- | ---------------------------------- |\n| sshfs                         | POSIX interface         | Slow, especially to fetch metadata |\n| rmate/nuclide                 | Fast, easy to use       | Requires IDE plugins               |\n| ssh + console ide (vim/emacs) | Needs no extra software | Lag when editing                   |\n| DropBox/syncthing             | Replicates all files    | Replicates all files               |\n\n\nCodeFS brings the POSIX interface of sshfs with the speed that comes with a dedicated server process.\n\n# Current State\n\nCodeFS is in alpha testing.  You should only use this on directories that are source controlled and you should git push often.\n\n# How to install\n\n## OS/X\n\nUse homebrew:\n\n```\nbrew cask install osxfuse\nbrew install --HEAD MisterTea/codefs/codefs\n```\n\n## Building from Source\n\nFirst install the dependencies (either from a package manager or source):\n\n1. Boost\n2. Protobuf\n3. GFlags\n4. ZeroMQ\n5. fswatch\n6. FUSE (or OSXFUSE for mac) for the client.  Build with -DBUILD_CLIENT=OFF to skip the client if you cannot install FUSE on the server.\n\nThen:\n\n```\ngit clone https://github.com/MisterTea/CodeFS.git --recurse-submodules\ncd CodeFS\nmkdir build\ncd build\ncmake ../\nmake -j4\nmake install\n```\n\n# User Guide\n\n## Starting the server\n\nNote that, as of now, there is **no** security or encryption.  This means that port 2298 should **not** be exposed to the outside.  Instead, codefs should be run over a secure layer, such as Eternal Terminal: https://github.com/MisterTea/EternalTerminal\n\nTo connect to the server with port forwarding:\n\n```\net -x -t=\"2298:2298\" my_server.com\n```\n\nThen inside the et/ssh session, run:\n\n```\ncodefsserver --path=/my/code/path --logtostdout\n```\n\nWhere ```/my/code/path``` is the location of your code.  For now, the server needs to be restarted every time the client (re)connects.\n\n## Running the client\n\nOn the client, run:\n\n```\ncodefs --path=/tmp/my_development_path --logtostdout\n```\n\nWhere ```/tmp/my_development_path``` is some empty folder that will act like a mirror to the folder on the server.\n\n# Troubleshooting\n\n### Client doesn't connect to server\n\nIn 0.0.1, the server needs to finish indexing the entire directory before the client will be able to connect to it.\n","funding_links":[],"categories":["C++"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMisterTea%2FCodeFS","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FMisterTea%2FCodeFS","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FMisterTea%2FCodeFS/lists"}