{"id":13585470,"url":"https://github.com/oxfs/oxfs","last_synced_at":"2026-03-17T16:38:51.418Z","repository":{"id":44937411,"uuid":"182289986","full_name":"oxfs/oxfs","owner":"oxfs","description":"✨A dead simple, fast SFTP file system ✨","archived":false,"fork":false,"pushed_at":"2023-09-19T13:05:15.000Z","size":10804,"stargazers_count":149,"open_issues_count":3,"forks_count":14,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-12-19T04:29:04.102Z","etag":null,"topics":["flask-application","fuse-filesystem","multithreading","pypi-packages","swagger-ui"],"latest_commit_sha":null,"homepage":"https://oxfs.io","language":"Python","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/oxfs.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":"2019-04-19T15:56:55.000Z","updated_at":"2025-09-16T04:16:10.000Z","dependencies_parsed_at":"2024-11-06T03:42:56.621Z","dependency_job_id":null,"html_url":"https://github.com/oxfs/oxfs","commit_stats":{"total_commits":64,"total_committers":4,"mean_commits":16.0,"dds":0.265625,"last_synced_commit":"cf6176de690461ab401db0b445657714d84d45bc"},"previous_names":[],"tags_count":7,"template":false,"template_full_name":null,"purl":"pkg:github/oxfs/oxfs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxfs%2Foxfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxfs%2Foxfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxfs%2Foxfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxfs%2Foxfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/oxfs","download_url":"https://codeload.github.com/oxfs/oxfs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/oxfs%2Foxfs/sbom","scorecard":{"id":715935,"data":{"date":"2025-08-11","repo":{"name":"github.com/oxfs/oxfs","commit":"7195575aab2f16b7e52b2f6112cac356b189087c"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.5,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":0,"reason":"Found 2/28 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 8 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T09:39:13.606Z","repository_id":44937411,"created_at":"2025-08-22T09:39:13.606Z","updated_at":"2025-08-22T09:39:13.606Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30627239,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T14:16:03.965Z","status":"ssl_error","status_checked_at":"2026-03-17T14:16:03.380Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["flask-application","fuse-filesystem","multithreading","pypi-packages","swagger-ui"],"created_at":"2024-08-01T15:04:57.732Z","updated_at":"2026-03-17T16:38:51.381Z","avatar_url":"https://github.com/oxfs.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n\u003ch1 align=\"center\"\u003eoxfs\u003c/h1\u003e\n\u003ch6 align=\"center\"\u003eA dead simple, fast SFTP file system\u003c/h6\u003e\n\u003c/p\u003e\n\u003cp align=\"center\"\u003e\n\u003cimg alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/oxfs\"\u003e\n\u003cimg alt=\"PyPI - Python Version\" src=\"https://img.shields.io/pypi/pyversions/oxfs\"\u003e\n\u003cimg alt=\"PyPI - Wheel\" src=\"https://img.shields.io/pypi/wheel/oxfs\"\u003e\n\u003cimg alt=\"GitHub last commit\" src=\"https://img.shields.io/github/last-commit/RainMark/oxfs\"\u003e\n\u003cimg alt=\"GitHub\" src=\"https://img.shields.io/github/license/RainMark/oxfs\"\u003e\n\u003c/p\u003e\n\nOxfs is a user-space network file system similar to SSHFS, and the underlying data transfer is based on the SFTP protocol. Oxfs introduces an asynchronous refresh policy to solve the jamming problem caused by the mismatch between network speed and user operation file speed. When Oxfs writes a file, it first writes to the local cache file and submits an asynchronous update task to update the content to the remote host. Similarly, when reading a file, it is preferred to read from a local cache file. Oxfs's data cache eventually falls to disk, and even if it is remounted, the history cache can still be used.\n\n![](files/mount.gif)\n![](files/operations.gif)\n![](files/umount.gif)\n\n## Get Started\n\n### Install\n\n- Ubuntu/Debian\n\n```sh\n$ sudo apt-get install fuse\n# python \u003e= 3.7\n$ sudo apt-get install python3.8\n$ python3.8 -m pip install oxfs\n```\n\n- MacOS\n  - Please install osxfuse firstly. [links](https://github.com/osxfuse/osxfuse/releases)\n\n```sh\n$ brew install python3\n$ mkdir ~/.venv\n$ python3 -m venv ~/.venv/oxfs\n$ source ~/.venv/oxfs/bin/activate\n$ pip install oxfs\n```\n\n### Usage\n\n```sh\n# mount\n$ oxfs --host mark@x.x.x.x --remote-path /home/mark --mount-point mark --cache-path ~/.oxfs --logging /tmp/oxfs.log --daemon --auto-cache\n\n# browse \u0026 edit\n$ cd mark\n\n# umount\n$ umount mark\n```\n\n### Help\n\n```sh\n$ oxfs -h\nusage: oxfs [-h] [--host HOST] [--ssh-port SSH_PORT] [--cache-timeout CACHE_TIMEOUT] [--parallel PARALLEL] [--mount-point MOUNT_POINT] [--remote-path REMOTE_PATH]\n            [--cache-path CACHE_PATH] [--logging LOGGING] [--daemon] [--auto-cache] [-v]\n\noptional arguments:\n  -h, --help            show this help message and exit\n  --host HOST           ssh host (example: root@127.0.0.1)\n  --ssh-port SSH_PORT   ssh port (defaut: 22)\n  --cache-timeout CACHE_TIMEOUT\n                        cache timeout (default: 30s)\n  --parallel PARALLEL   parallel (default: equal to cpu count)\n  --mount-point MOUNT_POINT\n                        mount point\n  --remote-path REMOTE_PATH\n                        remote path (default: /)\n  --cache-path CACHE_PATH\n                        cache path\n  --logging LOGGING     logging file\n  --daemon              daemon\n  --auto-cache          auto update cache\n  -v, --verbose         debug info\n```\n\n## Benchmark\n\n- sshfs: `fio -filename=fio20 -direct=1 -iodepth 1 -thread -rw=randread -rwmixread=70 -ioengine=psync -bs=4K -size=10M -numjobs=1 -runtime=100 -group_reporting -name=sshfs`\n- read: IOPS=149, BW=599KiB/s (**613kB/s**)(10.0MiB/17093msec)\n\n```sh\n\nsshfs: (g=0): rw=randread, bs=(R) 4096B-4096B, (W) 4096B-4096B, (T) 4096B-4096B, ioengine=psync, iodepth=1\nfio-3.29\nStarting 1 thread\nJobs: 1 (f=1): [r(1)][100.0%][r=604KiB/s][r=151 IOPS][eta 00m:00s]\nsshfs: (groupid=0, jobs=1): err= 0: pid=4611: Thu Mar 17 21:21:21 2022\n  read: IOPS=149, BW=599KiB/s (613kB/s)(10.0MiB/17093msec)\n    clat (usec): min=127, max=22361, avg=6663.51, stdev=862.88\n     lat (usec): min=128, max=22362, avg=6664.35, stdev=862.90\n    clat percentiles (usec):\n     |  1.00th=[ 5604],  5.00th=[ 5800], 10.00th=[ 5997], 20.00th=[ 6194],\n     | 30.00th=[ 6325], 40.00th=[ 6456], 50.00th=[ 6521], 60.00th=[ 6652],\n     | 70.00th=[ 6849], 80.00th=[ 7046], 90.00th=[ 7439], 95.00th=[ 7898],\n     | 99.00th=[ 8979], 99.50th=[ 9634], 99.90th=[15533], 99.95th=[20579],\n     | 99.99th=[22414]\n   bw (  KiB/s): min=  544, max=  624, per=99.65%, avg=597.85, stdev=16.06, samples=33\n   iops        : min=  136, max=  156, avg=149.09, stdev= 4.06, samples=33\n  lat (usec)   : 250=0.20%\n  lat (msec)   : 2=0.04%, 10=99.45%, 20=0.23%, 50=0.08%\n  cpu          : usr=0.36%, sys=1.57%, ctx=4977, majf=0, minf=26\n  IO depths    : 1=100.0%, 2=0.0%, 4=0.0%, 8=0.0%, 16=0.0%, 32=0.0%, \u003e=64=0.0%\n     submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     complete  : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     issued rwts: total=2560,0,0,0 short=0,0,0,0 dropped=0,0,0,0\n     latency   : target=0, window=0, percentile=100.00%, depth=1\n\nRun status group 0 (all jobs):\n   READ: bw=599KiB/s (613kB/s), 599KiB/s-599KiB/s (613kB/s-613kB/s), io=10.0MiB (10.5MB), run=17093-17093msec\n```\n\n- oxfs(first read): `fio -filename=fio10 -direct=1 -iodepth 1 -thread -rw=randread -rwmixread=70 -ioengine=psync -bs=4K -size=10M -numjobs=1 -runtime=100 -group_reporting -name=oxfs`\n- read: IOPS=1036, BW=4147KiB/s (**4247kB/s**)(10.0MiB/2469msec)\n\n```sh\noxfs: (g=0): rw=randread, bs=(R) 4096B-4096B, (W) 4096B-4096B, (T) 4096B-4096B, ioengine=psync, iodepth=1\nfio-3.29\nStarting 1 thread\nJobs: 1 (f=1): [r(1)][8.3%][r=517KiB/s][r=129 IOPS][eta 00m:33s]\noxfs: (groupid=0, jobs=1): err= 0: pid=2307: Thu Mar 17 21:25:21 2022\n  read: IOPS=1036, BW=4147KiB/s (4247kB/s)(10.0MiB/2469msec)\n    clat (usec): min=188, max=259502, avg=960.96, stdev=10153.30\n     lat (usec): min=188, max=259502, avg=961.26, stdev=10153.33\n    clat percentiles (usec):\n     |  1.00th=[   196],  5.00th=[   200], 10.00th=[   202], 20.00th=[   210],\n     | 30.00th=[   217], 40.00th=[   219], 50.00th=[   223], 60.00th=[   231],\n     | 70.00th=[   239], 80.00th=[   253], 90.00th=[   273], 95.00th=[   297],\n     | 99.00th=[   529], 99.50th=[ 53740], 99.90th=[191890], 99.95th=[221250],\n     | 99.99th=[258999]\n   bw (  KiB/s): min=   15, max= 4798, per=29.71%, avg=1232.75, stdev=2377.03, samples=4\n   iops        : min=    3, max= 1199, avg=307.50, stdev=594.38, samples=4\n  lat (usec)   : 250=78.55%, 500=20.43%, 750=0.20%\n  lat (msec)   : 20=0.04%, 50=0.27%, 100=0.23%, 250=0.23%, 500=0.04%\n  cpu          : usr=0.57%, sys=2.84%, ctx=2878, majf=0, minf=14\n  IO depths    : 1=100.0%, 2=0.0%, 4=0.0%, 8=0.0%, 16=0.0%, 32=0.0%, \u003e=64=0.0%\n     submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     complete  : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     issued rwts: total=2560,0,0,0 short=0,0,0,0 dropped=0,0,0,0\n     latency   : target=0, window=0, percentile=100.00%, depth=1\n\nRun status group 0 (all jobs):\n   READ: bw=4147KiB/s (4247kB/s), 4147KiB/s-4147KiB/s (4247kB/s-4247kB/s), io=10.0MiB (10.5MB), run=2469-2469msec\n```\n\n- oxfs(cached): `fio -filename=fio10 -direct=1 -iodepth 1 -thread -rw=randread -rwmixread=70 -ioengine=psync -bs=4K -size=10M -numjobs=1 -runtime=100 -group_reporting -name=oxfs-cached`\n- read: IOPS=4224, BW=16.5MiB/s (**17.3MB/s**)(10.0MiB/606msec)\n\n```sh\noxfs-cached: (g=0): rw=randread, bs=(R) 4096B-4096B, (W) 4096B-4096B, (T) 4096B-4096B, ioengine=psync, iodepth=1\nfio-3.29\nStarting 1 thread\n\noxfs-cached: (groupid=0, jobs=1): err= 0: pid=3075: Thu Mar 17 21:30:12 2022\n  read: IOPS=4224, BW=16.5MiB/s (17.3MB/s)(10.0MiB/606msec)\n    clat (usec): min=189, max=1055, avg=233.55, stdev=42.57\n     lat (usec): min=189, max=1056, avg=233.81, stdev=42.61\n    clat percentiles (usec):\n     |  1.00th=[  194],  5.00th=[  200], 10.00th=[  204], 20.00th=[  215],\n     | 30.00th=[  217], 40.00th=[  219], 50.00th=[  223], 60.00th=[  227],\n     | 70.00th=[  237], 80.00th=[  249], 90.00th=[  269], 95.00th=[  293],\n     | 99.00th=[  371], 99.50th=[  429], 99.90th=[  906], 99.95th=[  938],\n     | 99.99th=[ 1057]\n   bw (  KiB/s): min=17041, max=17041, per=100.00%, avg=17041.00, stdev= 0.00, samples=1\n   iops        : min= 4260, max= 4260, avg=4260.00, stdev= 0.00, samples=1\n  lat (usec)   : 250=80.82%, 500=18.95%, 750=0.12%, 1000=0.08%\n  lat (msec)   : 2=0.04%\n  cpu          : usr=1.82%, sys=10.25%, ctx=2671, majf=0, minf=9\n  IO depths    : 1=100.0%, 2=0.0%, 4=0.0%, 8=0.0%, 16=0.0%, 32=0.0%, \u003e=64=0.0%\n     submit    : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     complete  : 0=0.0%, 4=100.0%, 8=0.0%, 16=0.0%, 32=0.0%, 64=0.0%, \u003e=64=0.0%\n     issued rwts: total=2560,0,0,0 short=0,0,0,0 dropped=0,0,0,0\n     latency   : target=0, window=0, percentile=100.00%, depth=1\n\nRun status group 0 (all jobs):\n   READ: bw=16.5MiB/s (17.3MB/s), 16.5MiB/s-16.5MiB/s (17.3MB/s-17.3MB/s), io=10.0MiB (10.5MB), run=606-606msec\n```\n\n## Changelog\n\n- release/0.5.0\n  - [Improved] Add cache limit, lru policy.\n  - [Removed] Delete ApiServer.\n- release/0.4.0\n  - [New] Add auto-cache policy to sync file automately.\n- release/0.3.2\n  - [New] Add user/password auth support.\n  - [Improved] Add Config class, use subprocess.Popen.\n- release/0.3.1\n  - [Fixed] Fix no such file error when write occurred before read.\n- release/0.3.0\n  - [New] Add daemon support.\n  - [New] Upgrade to flask-restx.\n  - [Removed] Remove short argument.\n  - [Fixed] Fix bugs with git operations.\n  - [Fixed] Fix empty file write failed bug.\n  - [Fixed] Fix mount permission issue.\n- release/0.2.0\n  - [New] Add restful API to refresh the cache.\n- release/0.1.2\n  - [Removed] Remove auto_unmount fuse parameter, some osxfuse do not support it.\n  - [Deprecated] Disable the daemon parameter, turn on it in the future.\n- release/0.1.1\n  - [Added] enable the auto_cache by default.\n- release/0.1.0\n  - [Fixed] Fix the multi-thread bugs for rename operation.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxfs%2Foxfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Foxfs%2Foxfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Foxfs%2Foxfs/lists"}