{"id":16180847,"url":"https://github.com/cqb13/fmap","last_synced_at":"2025-04-07T12:11:34.287Z","repository":{"id":215859063,"uuid":"739535250","full_name":"cqb13/fmap","owner":"cqb13","description":"A CLI tool for displaying a tree like view of files and directories.","archived":false,"fork":false,"pushed_at":"2024-04-09T01:21:03.000Z","size":59,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-13T14:44:16.941Z","etag":null,"topics":["file-structure","file-structure-ascii-tree","file-structures","file-tree","file-tree-view","folder","folder-structure","folder-tree","folder-tree-view","folders","rust","rust-cli","terminal-tool","tree","tree-structure"],"latest_commit_sha":null,"homepage":"https://foldermap.cqb13.dev","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/cqb13.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}},"created_at":"2024-01-05T19:59:52.000Z","updated_at":"2024-06-11T15:02:54.000Z","dependencies_parsed_at":"2024-04-09T02:32:30.975Z","dependency_job_id":"70d692fe-e5b0-4065-b9fc-3d76f03e1748","html_url":"https://github.com/cqb13/fmap","commit_stats":{"total_commits":34,"total_committers":3,"mean_commits":"11.333333333333334","dds":0.08823529411764708,"last_synced_commit":"55f1dc91678a329d45630588f32092f21bfb332d"},"previous_names":["cqb13/fmap"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cqb13%2Ffmap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cqb13%2Ffmap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cqb13%2Ffmap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/cqb13%2Ffmap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/cqb13","download_url":"https://codeload.github.com/cqb13/fmap/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247648977,"owners_count":20972945,"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":["file-structure","file-structure-ascii-tree","file-structures","file-tree","file-tree-view","folder","folder-structure","folder-tree","folder-tree-view","folders","rust","rust-cli","terminal-tool","tree","tree-structure"],"created_at":"2024-10-10T06:10:22.795Z","updated_at":"2025-04-07T12:11:34.253Z","avatar_url":"https://github.com/cqb13.png","language":"Rust","readme":"# Fmap - File and Directory Mapping Tool\n\nFmap is a command-line tool written in Rust for displaying a tree-like view of files and directories. It provides functionality to scan directories, create a configuration file, manage ignored directories and files, and more.\n\n## Features\n\n- Display a tree-like view of files and directories.\n- Easily customize the scan path.\n- Create and manage a configuration file for persistent settings.\n- Add, remove, and list ignored directories and files.\n- Cross-platform support for Windows and macOS.\n\n## Commands\n\nThe following commands are available for use with Fmap:\n\n- **Basic Usage:**\n\n  ```bash\n  fmap              # Scans from the current directory\n  ```\n\n- **Commands:**\n\n  ```bash\n  # Scan Commands\n  fmap                         # Scans from the current directory with default options\n  fmap scan                    # Scans the current directory with options for file endings, sizes, and counts\n  fmap scan-path --path \"path\" # Scans a specific path with options for file endings, sizes, and counts\n\n  # Configuration Commands\n  fmap config                 # Creates or resets the configuration file\n\n  # Ignored Directories and Files Commands\n  fmap add --type \"file/dir\" --name \"name\"  # Adds a file or directory to the ignored list\n  fmap remove --type \"file/dir\" --name \"name\"  # Removes a file or directory from the ignored list\n  fmap list --type \"file/dir\"               # Lists all ignored files or directories\n\n  # Installation Command\n  fmap install                # Adds the binary to the PATH environment variable\n\n  # Version and Help Commands\n  fmap version                # Prints the version\n  fmap help                   # Prints the help\n  ```\n\n**Note:** Replace \"path,\" \"directory,\" and \"filename\" with your desired paths, directories, and filenames. Customize the scan options with flags such as `--endings`, `--file-sizes`, `--directory-sizes`, and `--file-counts-in-directories` for detailed information.\n\n## Example Output\n\n### Command\n\n```bash\nfmap scan --endings --file-counts-in-directories\n```\n\n### Output\n\n```bash\nfmap\n├── Cargo.toml\n├── LICENSE\n├── Cargo.lock\n├── README.md\n├── .gitignore\n└── src (6)\n    ├── display.rs\n    ├── config.rs\n    ├── commands.rs\n    ├── main.rs\n    ├── scan.rs\n    └── utils.rs\n```\n\n## Website\n\nYou can try out Fmap online at [https://foldermap.cqb13.dev](https://foldermap.cqb13.dev).\n\n## Installation\n\nRefer to the \"Installation\" section in the original markdown for platform-specific installation instructions.\n\n## Contributing\n\nFeel free to contribute to the project by submitting issues or pull requests on [GitHub](https://github.com/cqb13/fmap).\n\n## License\n\nThis project is licensed under the [MIT License](LICENSE).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqb13%2Ffmap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcqb13%2Ffmap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcqb13%2Ffmap/lists"}