{"id":13502887,"url":"https://github.com/dmcg310/Rust-Traverse","last_synced_at":"2025-03-29T12:33:08.572Z","repository":{"id":172316677,"uuid":"647862678","full_name":"dmcg310/Rust-Traverse","owner":"dmcg310","description":"Terminal based file explorer.","archived":false,"fork":false,"pushed_at":"2024-10-21T07:04:23.000Z","size":1665,"stargazers_count":76,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-31T22:33:08.402Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://crates.io/crates/rst-traverse","language":"Rust","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/dmcg310.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","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":"2023-05-31T17:22:50.000Z","updated_at":"2024-10-29T22:33:09.000Z","dependencies_parsed_at":null,"dependency_job_id":"bdc64428-fb64-4dbb-a560-7388fa03e161","html_url":"https://github.com/dmcg310/Rust-Traverse","commit_stats":null,"previous_names":["dmcg310/rust-traverse"],"tags_count":3,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmcg310%2FRust-Traverse","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmcg310%2FRust-Traverse/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmcg310%2FRust-Traverse/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dmcg310%2FRust-Traverse/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dmcg310","download_url":"https://codeload.github.com/dmcg310/Rust-Traverse/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246187190,"owners_count":20737459,"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-07-31T22:02:28.467Z","updated_at":"2025-03-29T12:33:08.163Z","avatar_url":"https://github.com/dmcg310.png","language":"Rust","funding_links":[],"categories":["Rust","\u003ca name=\"file-explorer\"\u003e\u003c/a\u003eFile explorer and tree visualization"],"sub_categories":[],"readme":"# Rust-Traverse\n\nRust traverse is a terminal based file explorer. It is inspired by the [NNN](https://github.com/jarun/nnn) file manager. It uses [Ratatui](https://github.com/tui-rs-revival/ratatui) for the terminal UI, with Crossterm for the terminal backend.\n\n\u003e To traverse or not to traverse?\n\n![Rust-Traverse](traverse.gif)\n\n## Features\n\n- [x] Full CRUD operations on files and directories.\n- [x] Move and copy files and directories.\n- [x] Keyboard shortcuts for navigation and operations, to make sure you don't have to leave the keyboard.\n- [x] Traverse directly to a directory by typing its path.\n- [x] Configurable.\n- [x] Extract tar.gz, or zip archives.\n- [x] Bookmarks for your favourite directories.\n- [x] Fuzzy finder for files in your current directory.\n- [x] Preview files in the terminal.\n- [x] Blazingly fast.\n\n## Installation\n\n### From source\n\n1. Install [Rust](https://www.rust-lang.org/tools/install).\n2. Clone the repository.\n3. Run `cargo build --release`.\n4. The binary will be in `target/release/rst-traverse`.\n5. Add the binary to your path.\n\n### From Cargo\n\n1. Install [Rust](https://www.rust-lang.org/tools/install).\n2. Run `cargo install rst-traverse`.\n3. Make sure cargo's bin directory is in your path.\n4. (Optional) Rename the binary to whatever suits you.\n\n### From Binary\n\n1. Download the binary from the releases page.\n2. `chmod +x rst-traverse` (linux only) within the same directory as it, to make it executable.\n3. Move the resulting binary to your path.\n\n## Usage\n\nRun `rst-traverse` in your terminal.\n\n### Keyboard Shortcuts\n\n#### Navigation\n\n- `ESC` or `q`: Quit the application.\n- `1`: Select the Files pane.\n- `2`: Select the Directories pane.\n- `j`: Select the next item in the current pane.\n- `k`: Select the previous item in the current pane.\n\n#### File and Directory Operations\n\n- `n`: Create a new file or directory, depending on the current pane.\n- `CTRL + d`: Delete the selected file or directory, (to bin).\n- `r`: Rename the selected file or directory.\n- `f`: Navigate to a directory using a relative or absolute path.\n- `x`: Extract the selected archive, to the current directory.\n\n#### Move/Copy Operations\n\n- `c`: Append the selected file or directory to the move/copy buffer.\n- `p`: Opens the move/copy buffer menu, (enter on any option is in relation to your current directory).\n\n#### Fuzzy Finder Operations\n\n- `w`: Toggle fzf.\n- `CTRL + n`: 'Next' item in results.\n- `CTRL + p`: 'Previous' item in results.\n\n#### Bookmark Operations\n\n- `b`: Shows bookmarks menu.\n- `z`: Add current directory to bookmarks.\n- `CTRL + n`: 'Next' bookmark in menu.\n- `CTRL + p`: 'Previous' bookmark in menu.\n\n#### Help\n\n- `?`: Shows help menu.\n\n## Configuration\n\nThe configuration file is located at `\u003cconfig-dir\u003e/traverse/config.txt`. The default configuration is as follows:\n\n```\nshow_hidden=false\nexcluded_directories=.git,.idea,.vscode,target\n```\n\nThe excluded directories are directories that will not be searched when using the FZF.\n\nThe bookmarks file is located at `\u003cconfig-dir\u003e/traverse/bookmarks.txt`.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmcg310%2FRust-Traverse","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdmcg310%2FRust-Traverse","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdmcg310%2FRust-Traverse/lists"}