# F2 Commander
F2 Commander is an orthodox file manager for the modern world.
## Status
F2 Commander is usable, with a core set of features implemented. While it is
functional, development is ongoing. See the "Roadmap" below for a complete
feature list and their status. This is a personal project with all its
implications. See the "About" section below for more information. Users are
encouraged to contribute and report issues.
## Installation
From source:
poetry build
pipx install [--force] dist/f2_commander-0.1.0.tar.gz
This software is designed to work in Linux and MacOS. It should also work in
WSL (Windows Subsystem for Linux).
## Usage
- Start by running `f2` in your terminal emulator
- Hit `?` to see the built-in help
- Hit `q` to quit
## Roadmap
F2 Commander mission is to bring the experience of an orthodox file
manager into the world of modern computing.
F2 Commander main principles are:
- "file system" can be anything that contains files, blobs, etc.
- focus on the **tasks** for file manipulation
- discoverability of file systems (making file systems easy to navigate)
- discoverability of the tool itself (making it easy and evident to use)
- the software should be easy to adapt, shape and extend
Features:
- User Interface
- [x] Two-panel interface
- [x] Classic footer with common user actions
- [ ] Contextual footer (changes actions based on context)
- [ ] Configurable key bindings. "Modern" and "Retro" bindings out of the box.
- [ ] Menubar
- [x] Command Palette
- [ ] File Info / Preview panel
- [x] Drop to shell (command line) temporarily
- [ ] Theming. "Modern" and "Retro" themes out of the box.
- Configuration
- [x] User configuration file
- [ ] UI for most common configuration options
- [ ] Options for user-defined viewer, editor, shell, and default file actions
- [ ] Enable/disable CWD following the user selection
- [ ] Enable/disable case sensitivity when ordering by name
- [ ] List dirs first toggle
- [ ] Starting directory for each pane (cwd, home, fixed path, or last location)
- Navigation
- [x] Basic file and directory info: entry names, human-readable size,
last modification time, show and follow symlinks, etc.
- [x] Vim-like (up/down j/k g/G ctrl+f/d/b/u) navigation
- [x] Navigate "up" (with backspace or with the ".." entry)
- [x] Order entries by name, size, time (last modification time)
- [x] Filter entries with glob
- [x] Directory summary in the file listing footer
- [x] "List dirs first/inline" toggle
- [x] Ordering by name case sensitivity on/off
- [ ] Quick search: navigate file list by typing in the file names
- [ ] Navigate to path (enter path, with auto-completion)
- [ ] Bookmarks (set and navigate to the bookmarks)
- [x] "Same location" and "Swap panels" actions
- [ ] CWD follows user selection
- [ ] Detect external changes and update file listing when possible
- [x] Open current location in the OS default file manager
- File and directory manipulation
- [x] Basic operations like copy, move, move to trash, etc.
- [x] Confirmation dialogs and user inputs (destination path, etc.)
- [x] Multiple file selection
- [ ] Progress bar for long operations
- [ ] Option to delete files (as opposed to moving to trash)
- [x] View and edit files using user default viewer and editor
- [x] "Open" files with a default associated program (e.g., view PDF, etc.)
- [ ] Run programs (run executable files)
- [x] Create a new directory
- [ ] Create a new file
- [x] "Show/hide hidden files" toggle
- [ ] Create and modify symlinks, show broken, and other symlink tasks
- [ ] Compute directory size on selection
- "File systems" support
- [x] "Local" OS file system
- [ ] AWS S3
- [ ] GCP GCS
- [ ] Dropbox
- [ ] FTP, FTPS, SFTP
- [ ] ... show must go on ...
- Archival and compression support
- [ ] ZIP (read, create, update)
- [ ] ... and more ...
- Documentation
- [x] Built-in help
- [ ] User manual
- Windows support. You are probably better off with WSL, but some day, maybe...
- [ ] Test all features in Windows
- [ ] Then, maybe plan fixes
User experience and app behavior:
- Dialogs
- [ ] "Do not ask me again" option in "safe" dialogs (e.g., "Quit" dialog)
- [ ] Allow "Enter" and "y" keys in "safe" dialogs for confirmation
- Navigation
- [x] Save user's choises between restarts (hidden files toggle, dirs first, etc.)
- [ ] Consistent cursor positioning
- [x] ... on the source directory when navigating "up"
- [ ] ... on the source link when navigating back from symlink
- [ ] ... on the nearest entry after delete or move
- [ ] Clicking on list headers changes ordering in according columns
Known bugs to fix:
- Restore the "show hidden files" state when switching back to the file list
after having used a different panel type.
- Errors in copy, move, etc. are not handled (e.g., destination directory
doesn't exist, etc.). Note that not only preconditions should be checked,
but also the errors should be handled (e.g., destination can be deleted
during copy, network connection dropped, etc.)
- ".." path is allowed for selection and can be copied, moved, etc.; handle
".." and empty selections better
- File info and preview panels show nothing on start unless a selection is
changed in the file list.
- Default viewer, editor, shell and "open" programs are mostly MacOS-specific,
choices are too rigid. Make sure defaults work on clean MacOS and Linux
installs.
- File list has an unnecessary 2-column (2 character wide) gap even when no
vertical scroll bar is present (2 characters are reserved for the scroll
bar)
- Ctrl+U / Ctrl+D should scroll half a page (not en entire page)
- Selection is always cleared if "Hidden files" toggle is changed
## Development environment
This project uses Poetry for dependency management and as a build tool. The
configuration is conventional, use as usual:
poetry install --with dev
It also uses black, flake8, isort, mypy and pytest. An IDE or an LSP should
pick up their configuration, or they can be executed with poetry. For example:
poetry run pytest
To run all code quality controls and linters:
./check
To run the application from source code:
poetry run f2
To run the application with dev tools:
poetry run textual console [-v -x SYSTEM -x EVENT -x DEBUG -x INFO] # this first!
poetry run textual run --dev f2.app:F2Commander
## About
"F2" is a loose interpretation of "a **F**ile manager with **2** side-by-side
panels", and "Commander" is an homage to the old-school orthodox file managers.
"F2 Commander" is a personal project that has grown into a full-fledged file
manager and is now open-sourced. Being a personal project means that: a) my
intent is to follow the "Roadmap" outlined above, but development and bug fixing
may be irregularly-paced and priorities may shift; b) the intent is to keep it
stable, yet future versions may include backward-incompatible changes where that
would seem practical to do.
## Contributions
Bug reports, feature requests and pull requests are welcome.
If you plan to contirbute to the source code, see the "Development environment"
above, and make sure to run the linters.
## License
This application is provided "as is", without warranty of any kind.
Mozilla Public License, v. 2.0.
Raw data
{
"_id": null,
"home_page": "https://github.com/candidtim/f2-commander",
"name": "f2-commander",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "file, manager, commander",
"author": "Timur Rubeko",
"author_email": "timcandid@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/4f/8c/30c7e93de0d588445de15922d6cf2df4d066367dda402f8a70084176f09f/f2_commander-0.1.0.tar.gz",
"platform": null,
"description": "# F2 Commander\n\nF2 Commander is an orthodox file manager for the modern world.\n\n![F2 Commander Demo](img/f2.png \"F2 Commander\")\n\n## Status\n\nF2 Commander is usable, with a core set of features implemented. While it is\nfunctional, development is ongoing. See the \"Roadmap\" below for a complete\nfeature list and their status. This is a personal project with all its\nimplications. See the \"About\" section below for more information. Users are\nencouraged to contribute and report issues.\n\n## Installation\n\nFrom source:\n\n poetry build\n pipx install [--force] dist/f2_commander-0.1.0.tar.gz\n\nThis software is designed to work in Linux and MacOS. It should also work in\nWSL (Windows Subsystem for Linux).\n\n## Usage\n\n - Start by running `f2` in your terminal emulator\n - Hit `?` to see the built-in help\n - Hit `q` to quit\n\n## Roadmap\n\nF2 Commander mission is to bring the experience of an orthodox file\nmanager into the world of modern computing.\n\nF2 Commander main principles are:\n\n - \"file system\" can be anything that contains files, blobs, etc.\n - focus on the **tasks** for file manipulation\n - discoverability of file systems (making file systems easy to navigate)\n - discoverability of the tool itself (making it easy and evident to use)\n - the software should be easy to adapt, shape and extend\n\nFeatures:\n\n - User Interface\n\n - [x] Two-panel interface\n - [x] Classic footer with common user actions\n - [ ] Contextual footer (changes actions based on context)\n - [ ] Configurable key bindings. \"Modern\" and \"Retro\" bindings out of the box.\n - [ ] Menubar\n - [x] Command Palette\n - [ ] File Info / Preview panel\n - [x] Drop to shell (command line) temporarily\n - [ ] Theming. \"Modern\" and \"Retro\" themes out of the box.\n\n - Configuration\n\n - [x] User configuration file\n - [ ] UI for most common configuration options\n - [ ] Options for user-defined viewer, editor, shell, and default file actions\n - [ ] Enable/disable CWD following the user selection\n - [ ] Enable/disable case sensitivity when ordering by name\n - [ ] List dirs first toggle\n - [ ] Starting directory for each pane (cwd, home, fixed path, or last location)\n\n - Navigation\n\n - [x] Basic file and directory info: entry names, human-readable size,\n last modification time, show and follow symlinks, etc.\n - [x] Vim-like (up/down j/k g/G ctrl+f/d/b/u) navigation\n - [x] Navigate \"up\" (with backspace or with the \"..\" entry)\n - [x] Order entries by name, size, time (last modification time)\n - [x] Filter entries with glob\n - [x] Directory summary in the file listing footer\n - [x] \"List dirs first/inline\" toggle\n - [x] Ordering by name case sensitivity on/off\n - [ ] Quick search: navigate file list by typing in the file names\n - [ ] Navigate to path (enter path, with auto-completion)\n - [ ] Bookmarks (set and navigate to the bookmarks)\n - [x] \"Same location\" and \"Swap panels\" actions\n - [ ] CWD follows user selection\n - [ ] Detect external changes and update file listing when possible\n - [x] Open current location in the OS default file manager\n\n - File and directory manipulation\n\n - [x] Basic operations like copy, move, move to trash, etc.\n - [x] Confirmation dialogs and user inputs (destination path, etc.)\n - [x] Multiple file selection\n - [ ] Progress bar for long operations\n - [ ] Option to delete files (as opposed to moving to trash)\n - [x] View and edit files using user default viewer and editor\n - [x] \"Open\" files with a default associated program (e.g., view PDF, etc.)\n - [ ] Run programs (run executable files)\n - [x] Create a new directory\n - [ ] Create a new file\n - [x] \"Show/hide hidden files\" toggle\n - [ ] Create and modify symlinks, show broken, and other symlink tasks\n - [ ] Compute directory size on selection\n\n - \"File systems\" support\n\n - [x] \"Local\" OS file system\n - [ ] AWS S3\n - [ ] GCP GCS\n - [ ] Dropbox\n - [ ] FTP, FTPS, SFTP\n - [ ] ... show must go on ...\n\n - Archival and compression support\n\n - [ ] ZIP (read, create, update)\n - [ ] ... and more ...\n\n - Documentation\n\n - [x] Built-in help\n - [ ] User manual\n\n - Windows support. You are probably better off with WSL, but some day, maybe...\n\n - [ ] Test all features in Windows\n - [ ] Then, maybe plan fixes\n\nUser experience and app behavior:\n\n - Dialogs\n\n - [ ] \"Do not ask me again\" option in \"safe\" dialogs (e.g., \"Quit\" dialog)\n - [ ] Allow \"Enter\" and \"y\" keys in \"safe\" dialogs for confirmation\n\n - Navigation\n\n - [x] Save user's choises between restarts (hidden files toggle, dirs first, etc.)\n - [ ] Consistent cursor positioning\n - [x] ... on the source directory when navigating \"up\"\n - [ ] ... on the source link when navigating back from symlink\n - [ ] ... on the nearest entry after delete or move\n - [ ] Clicking on list headers changes ordering in according columns\n\nKnown bugs to fix:\n\n - Restore the \"show hidden files\" state when switching back to the file list\n after having used a different panel type.\n\n - Errors in copy, move, etc. are not handled (e.g., destination directory\n doesn't exist, etc.). Note that not only preconditions should be checked,\n but also the errors should be handled (e.g., destination can be deleted\n during copy, network connection dropped, etc.)\n\n - \"..\" path is allowed for selection and can be copied, moved, etc.; handle\n \"..\" and empty selections better\n\n - File info and preview panels show nothing on start unless a selection is\n changed in the file list.\n\n - Default viewer, editor, shell and \"open\" programs are mostly MacOS-specific,\n choices are too rigid. Make sure defaults work on clean MacOS and Linux\n installs.\n\n - File list has an unnecessary 2-column (2 character wide) gap even when no\n vertical scroll bar is present (2 characters are reserved for the scroll\n bar)\n\n - Ctrl+U / Ctrl+D should scroll half a page (not en entire page)\n\n - Selection is always cleared if \"Hidden files\" toggle is changed\n\n## Development environment\n\nThis project uses Poetry for dependency management and as a build tool. The\nconfiguration is conventional, use as usual:\n\n poetry install --with dev\n\nIt also uses black, flake8, isort, mypy and pytest. An IDE or an LSP should\npick up their configuration, or they can be executed with poetry. For example:\n\n poetry run pytest\n\nTo run all code quality controls and linters:\n\n ./check\n\nTo run the application from source code:\n\n poetry run f2\n\nTo run the application with dev tools:\n\n poetry run textual console [-v -x SYSTEM -x EVENT -x DEBUG -x INFO] # this first!\n poetry run textual run --dev f2.app:F2Commander\n\n## About\n\n\"F2\" is a loose interpretation of \"a **F**ile manager with **2** side-by-side\npanels\", and \"Commander\" is an homage to the old-school orthodox file managers.\n\n\"F2 Commander\" is a personal project that has grown into a full-fledged file\nmanager and is now open-sourced. Being a personal project means that: a) my\nintent is to follow the \"Roadmap\" outlined above, but development and bug fixing\nmay be irregularly-paced and priorities may shift; b) the intent is to keep it\nstable, yet future versions may include backward-incompatible changes where that\nwould seem practical to do.\n\n## Contributions\n\nBug reports, feature requests and pull requests are welcome.\n\nIf you plan to contirbute to the source code, see the \"Development environment\"\nabove, and make sure to run the linters.\n\n## License\n\nThis application is provided \"as is\", without warranty of any kind.\n\nMozilla Public License, v. 2.0.\n",
"bugtrack_url": null,
"license": "MPL-2.0",
"summary": "F2 Commander is an orthodox file manager for the modern world.",
"version": "0.1.0",
"project_urls": {
"Bug Tracker": "https://github.com/candidtim/f2-commander/issues",
"Homepage": "https://github.com/candidtim/f2-commander",
"Repository": "https://github.com/candidtim/f2-commander"
},
"split_keywords": [
"file",
" manager",
" commander"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "0b0f739772b2c3b97b7b7722d591842b3abcd1a7c43c0c8424fddec591b93580",
"md5": "51966408400c2a3c91609e276518f4b7",
"sha256": "80d313a15083756d805aff0342919aacb30d2683a1197cfcdb6e197f12aee14c"
},
"downloads": -1,
"filename": "f2_commander-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "51966408400c2a3c91609e276518f4b7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 27965,
"upload_time": "2024-08-18T12:48:47",
"upload_time_iso_8601": "2024-08-18T12:48:47.530262Z",
"url": "https://files.pythonhosted.org/packages/0b/0f/739772b2c3b97b7b7722d591842b3abcd1a7c43c0c8424fddec591b93580/f2_commander-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f8c30c7e93de0d588445de15922d6cf2df4d066367dda402f8a70084176f09f",
"md5": "09d07f555fb8803b3ce1fb1e03b8d4e3",
"sha256": "3780d5270bfd4b88111a86c56de89dedfd02b2b5354d753478e7b122e0d76a7c"
},
"downloads": -1,
"filename": "f2_commander-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "09d07f555fb8803b3ce1fb1e03b8d4e3",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 25476,
"upload_time": "2024-08-18T12:48:49",
"upload_time_iso_8601": "2024-08-18T12:48:49.271377Z",
"url": "https://files.pythonhosted.org/packages/4f/8c/30c7e93de0d588445de15922d6cf2df4d066367dda402f8a70084176f09f/f2_commander-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-18 12:48:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "candidtim",
"github_project": "f2-commander",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "f2-commander"
}
JSON
