| Name | oakfs JSON |
| Version |
0.4.2
JSON |
| download |
| home_page | None |
| Summary | A humane CLI-based filesystem exploration tool, for humans. |
| upload_time | 2025-09-18 22:24:50 |
| maintainer | None |
| docs_url | None |
| author | Ritchie Mwewa |
| requires_python | <4.0,>=3.12 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="https://i.imgur.com/BpRXcOW.png" alt="oakfs logo" width="350"/>
<br>
<strong>Oakfs</strong> is a humane CLI-based filesystem exploration tool, for humans.<br/>
It provides a colourful, human-friendly way to explore your filesystem in the terminal using either a <b>tree</b> or <b>table view</b>.
</p>
## ✨ Features
- 🌳 **Tree view**: Visualise your filesystem hierarchy like `tree` but prettier.
- 📊 **Table view**: Display directories in a sortable table with file size, type, permissions, and modified time.
- 🎨 **Rich styling**: Icons and colours for file types (documents, images, audio, code, archives, etc.).
- 🔍 **Filtering**:
- `-a, --all`: include hidden files
- `-d, --directories`: show only directories
- `-f, --files`: show only files
- `-s, --symlinks`: show only symlinks
- `-j, --junctions`: show only junctions (Windows)
- 👥 **Ownership info**: Show owner, group, and permissions with `--groups`.
- 🕒 **Timestamps**: Choose between `relative` relative times (`3 minutes ago`) or `locale` formatted dates.
- 🔄 **Sorting**: Reverse order with `--reverse`.
> [!Note]
> To make your experience more pleasant, you'll need to have Nerd Fonts installed. Check out
> the [Nerd Fonts website](https://www.nerdfonts.com/) for instructions on how to install them.
## 📦 Installation
**Oakfs** is available on [PyPI](https://pypi.org/project/pypi), and can be installed with pip:
```bash
pip install oakfs
```
This will install `oak` as a CLI command.
## 🚀 Usage
Run `oak` from the command line:
### Table view (default)
```bash
oak [PATH]
```
Example:
```bash
oak ~/projects
```
### Tree view
```bash
oak --tree [PATH]
```
Example:
```bash
oak --tree ~/projects
```
> [!Note]
> If no path is provided, it defaults to the current working directory.
> [!Tip]
> If you decide not to install Nerd Fonts (_because you've decided to become a caveperson for some reason_), you can
> always run `oak` with the `-N, --no-icons` option.
>> This should help with embracing the **unga bunga** within you.
## ⚙️ Options
| Option | Description |
|-------------------------------------------------------------------------------|----------------------------------------------------|
| `-t, --tree` | show filesystem hierarchy in a tree view structure |
| `-a, --all` | show hidden files and/or directories |
| `-f, --files` | show files only |
| `-d, --directories` | show directories only |
| `-s, --symlinks` | show symlinks only |
| `-j, --junctions` | show junctions only <Windows> |
| `-r, --reverse` | reverse sort order |
| `-g, --groups` | show groups |
| `-o, --owners` | show owners |
| `-p, --permissions` | show permissions |
| `-m, --mimetypes` | show mimetypes |
| `-v, --verbose` | enable verbose output |
| `-N, --no-icons` | disable showing icons in output |
| `-D, --dt-format [relative\|locale]` | output datetime format (default: |
| relative) | |
| `-T, --table-style [ASCII\|ROUNDED\|SQUARE\|HEAVY\|DOUBLE\|SIMPLE\|MINIMAL]` | table border style (default: |
| ROUNDED) | |
| `-h, --help` | show help message and exit |
| `--version` | show version and exit |
> [!Note]
> The following options are available only in the default (table) view: `--owners`, `--permissions`,
`--groups`, `--mimetypes`, `--dt-format`, and obviously `--table-style`
<p align="center">
<strong>ok. that's all (for now).</strong>
</p>
Raw data
{
"_id": null,
"home_page": null,
"name": "oakfs",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.12",
"maintainer_email": null,
"keywords": null,
"author": "Ritchie Mwewa",
"author_email": "rly0nheart@duck.com",
"download_url": "https://files.pythonhosted.org/packages/e1/8e/ee238e1bab9b3405cfc49c0c79ac5fef7a202d172faca33ec51367910094/oakfs-0.4.2.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"https://i.imgur.com/BpRXcOW.png\" alt=\"oakfs logo\" width=\"350\"/>\n <br>\n <strong>Oakfs</strong> is a humane CLI-based filesystem exploration tool, for humans.<br/>\n It provides a colourful, human-friendly way to explore your filesystem in the terminal using either a <b>tree</b> or <b>table view</b>.\n</p>\n\n## \u2728 Features\n\n- \ud83c\udf33 **Tree view**: Visualise your filesystem hierarchy like `tree` but prettier.\n- \ud83d\udcca **Table view**: Display directories in a sortable table with file size, type, permissions, and modified time.\n- \ud83c\udfa8 **Rich styling**: Icons and colours for file types (documents, images, audio, code, archives, etc.).\n- \ud83d\udd0d **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- \ud83d\udc65 **Ownership info**: Show owner, group, and permissions with `--groups`.\n- \ud83d\udd52 **Timestamps**: Choose between `relative` relative times (`3 minutes ago`) or `locale` formatted dates.\n- \ud83d\udd04 **Sorting**: Reverse order with `--reverse`.\n\n> [!Note]\n> To make your experience more pleasant, you'll need to have Nerd Fonts installed. Check out\n> the [Nerd Fonts website](https://www.nerdfonts.com/) for instructions on how to install them.\n\n## \ud83d\udce6 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## \ud83d\ude80 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> [!Note]\n> If no path is provided, it defaults to the current working directory.\n\n> [!Tip]\n> If you decide not to install Nerd Fonts (_because you've decided to become a caveperson for some reason_), you can\n> always run `oak` with the `-N, --no-icons` option.\n>> This should help with embracing the **unga bunga** within you.\n\n## \u2699\ufe0f 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 <Windows> |\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> [!Note]\n> 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<p align=\"center\">\n <strong>ok. that's all (for now).</strong>\n</p>\n",
"bugtrack_url": null,
"license": null,
"summary": "A humane CLI-based filesystem exploration tool, for humans.",
"version": "0.4.2",
"project_urls": {
"issues": "https://github.com/rly0nheart/oakfs/issues",
"repository": "https://github.com/rly0nheart/oakfs"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "2af493cf9d6eaf42146a0d405ae6c0995f9945bd5f5830b3693fa2a9bf31463c",
"md5": "4f2c66f7096dc4fd48d8d6547adc2b65",
"sha256": "1840e16e7b063d9d557fc8294fe84274f89545e0f92de2ae9f6b83de9663dcc4"
},
"downloads": -1,
"filename": "oakfs-0.4.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4f2c66f7096dc4fd48d8d6547adc2b65",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.12",
"size": 13038,
"upload_time": "2025-09-18T22:24:49",
"upload_time_iso_8601": "2025-09-18T22:24:49.038805Z",
"url": "https://files.pythonhosted.org/packages/2a/f4/93cf9d6eaf42146a0d405ae6c0995f9945bd5f5830b3693fa2a9bf31463c/oakfs-0.4.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "e18eee238e1bab9b3405cfc49c0c79ac5fef7a202d172faca33ec51367910094",
"md5": "a471a401cbcad67772cd6853acab59b0",
"sha256": "cec61ead3457a0b4db67195e2f65dc2d43efe4ca6b3aad2546de14d492f12eb2"
},
"downloads": -1,
"filename": "oakfs-0.4.2.tar.gz",
"has_sig": false,
"md5_digest": "a471a401cbcad67772cd6853acab59b0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.12",
"size": 12186,
"upload_time": "2025-09-18T22:24:50",
"upload_time_iso_8601": "2025-09-18T22:24:50.461497Z",
"url": "https://files.pythonhosted.org/packages/e1/8e/ee238e1bab9b3405cfc49c0c79ac5fef7a202d172faca33ec51367910094/oakfs-0.4.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-18 22:24:50",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rly0nheart",
"github_project": "oakfs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "oakfs"
}
