{"id":31202869,"url":"https://github.com/rly0nheart/oakfs","last_synced_at":"2025-09-20T14:14:33.452Z","repository":{"id":314887483,"uuid":"1054941185","full_name":"rly0nheart/oakfs","owner":"rly0nheart","description":"a cute filesystem visualisation tool, for cute humans 🙂","archived":false,"fork":false,"pushed_at":"2025-09-15T11:35:04.000Z","size":663,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-09-15T13:10:56.223Z","etag":null,"topics":["filesystem","filesystem-visualization"],"latest_commit_sha":null,"homepage":"https://pypi.org/p/oakfs","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/rly0nheart.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-11T14:39:22.000Z","updated_at":"2025-09-15T11:34:04.000Z","dependencies_parsed_at":"2025-09-15T13:11:04.982Z","dependency_job_id":"4b6822f7-777c-4e36-86ea-dc7f46774e5c","html_url":"https://github.com/rly0nheart/oakfs","commit_stats":null,"previous_names":["rly0nheart/oakfs"],"tags_count":10,"template":false,"template_full_name":null,"purl":"pkg:github/rly0nheart/oakfs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rly0nheart%2Foakfs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rly0nheart%2Foakfs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rly0nheart%2Foakfs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rly0nheart%2Foakfs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/rly0nheart","download_url":"https://codeload.github.com/rly0nheart/oakfs/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/rly0nheart%2Foakfs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":276106042,"owners_count":25586191,"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-20T02:00:10.207Z","response_time":63,"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":["filesystem","filesystem-visualization"],"created_at":"2025-09-20T14:14:32.465Z","updated_at":"2025-09-20T14:14:33.444Z","avatar_url":"https://github.com/rly0nheart.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"https://i.imgur.com/BpRXcOW.png\" alt=\"oakfs logo\" width=\"350\"/\u003e\n  \u003cbr\u003e\n  \u003cstrong\u003eOakfs\u003c/strong\u003e is a humane CLI-based filesystem exploration tool, for humans.\u003cbr/\u003e\n  It provides a colourful, human-friendly way to explore your filesystem in the terminal using either a \u003cb\u003etree\u003c/b\u003e or \u003cb\u003etable view\u003c/b\u003e.\n\u003c/p\u003e\n\n## ✨ Features\n\n- 🌳 **Tree view**: Visualise your filesystem hierarchy like `tree` but prettier.\n- 📊 **Table view**: Display directories in a sortable table with file size, type, permissions, and modified time.\n- 🎨 **Rich styling**: Icons and colours for file types (documents, images, audio, code, archives, etc.).\n- 🔍 **Filtering**:\n    - `-a, --all`: include hidden files\n    - `-d, --directories`: show only directories\n    - `-f, --files`: show only files\n    - `-s, --symlinks`: show only symlinks\n    - `-j, --junctions`: show only junctions (Windows)\n\n- 👥 **Ownership info**: Show owner, group, and permissions with `--groups`.\n- 🕒 **Timestamps**: Choose between `relative` relative times (`3 minutes ago`) or `locale` formatted dates.\n- 🔄 **Sorting**: Reverse order with `--reverse`.\n\n\u003e [!Note]\n\u003e To make your experience more pleasant, you'll need to have Nerd Fonts installed. Check out\n\u003e the [Nerd Fonts website](https://www.nerdfonts.com/) for instructions on how to install them.\n\n## 📦 Installation\n\n**Oakfs** is available on [PyPI](https://pypi.org/project/pypi), and can be installed with pip:\n\n```bash\npip install oakfs\n```\n\nThis will install `oak` as a CLI command.\n\n## 🚀 Usage\n\nRun `oak` from the command line:\n\n### Table view (default)\n\n```bash\noak [PATH]\n```\n\nExample:\n\n```bash\noak ~/projects\n```\n\n### Tree view\n\n```bash\noak --tree [PATH]\n```\n\nExample:\n\n```bash\noak --tree ~/projects\n```\n\n\u003e [!Note]\n\u003e If no path is provided, it defaults to the current working directory.\n\n\u003e [!Tip]\n\u003e If you decide not to install Nerd Fonts (_because you've decided to become a caveperson for some reason_), you can\n\u003e always run `oak` with the `-N, --no-icons` option.\n\u003e\u003e This should help with embracing the **unga bunga** within you.\n\n## ⚙️ Options\n\n| Option                                                                        | Description                                        |\n|-------------------------------------------------------------------------------|----------------------------------------------------|\n| `-t, --tree`                                                                  | show filesystem hierarchy in a tree view structure |\n| `-a, --all`                                                                   | show hidden files and/or directories               |\n| `-f, --files`                                                                 | show files only                                    |\n| `-d, --directories`                                                           | show directories only                              |\n| `-s, --symlinks`                                                              | show symlinks only                                 |\n| `-j, --junctions`                                                             | show junctions only \u003cWindows\u003e                      |\n| `-r, --reverse`                                                               | reverse sort order                                 |\n| `-g, --groups`                                                                | show groups                                        |\n| `-o, --owners`                                                                | show owners                                        |\n| `-p, --permissions`                                                           | show permissions                                   |\n| `-m, --mimetypes`                                                             | show mimetypes                                     |\n| `-v, --verbose`                                                               | enable verbose output                              |\n| `-N, --no-icons`                                                              | disable showing icons in output                    |\n| `-D, --dt-format [relative\\|locale]`                                          | output datetime format (default:                   |\n| relative)                                                                     |                                                    |\n| `-T, --table-style  [ASCII\\|ROUNDED\\|SQUARE\\|HEAVY\\|DOUBLE\\|SIMPLE\\|MINIMAL]` | table border style (default:                       |\n| ROUNDED)                                                                      |                                                    |\n| `-h, --help`                                                                  | show help message and exit                         |\n| `--version`                                                                   | show version and exit                              |\n\n\u003e [!Note]\n\u003e The following options are available only in the default (table) view: `--owners`, `--permissions`,\n`--groups`, `--mimetypes`, `--dt-format`, and obviously `--table-style`\n\n\n\u003cp align=\"center\"\u003e\n  \u003cstrong\u003eok. that's all (for now).\u003c/strong\u003e\n\u003c/p\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frly0nheart%2Foakfs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frly0nheart%2Foakfs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frly0nheart%2Foakfs/lists"}