{"id":23503316,"url":"https://github.com/code-env/tidyup","last_synced_at":"2025-04-04T11:09:09.144Z","repository":{"id":269610219,"uuid":"907582169","full_name":"code-env/tidyup","owner":"code-env","description":"A simple CLI tool to organize your folders and files.","archived":false,"fork":false,"pushed_at":"2025-02-01T06:39:57.000Z","size":157,"stargazers_count":150,"open_issues_count":1,"forks_count":10,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-28T10:09:15.846Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://tidyup.bossadizenith.me","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/code-env.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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":"2024-12-23T23:32:03.000Z","updated_at":"2025-03-28T03:24:29.000Z","dependencies_parsed_at":"2025-02-01T07:23:53.968Z","dependency_job_id":"133731e1-b986-4ca4-bb8e-1950a6c18378","html_url":"https://github.com/code-env/tidyup","commit_stats":null,"previous_names":["code-env/tidyup"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-env%2Ftidyup","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-env%2Ftidyup/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-env%2Ftidyup/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/code-env%2Ftidyup/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/code-env","download_url":"https://codeload.github.com/code-env/tidyup/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247166167,"owners_count":20894654,"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-12-25T08:26:41.861Z","updated_at":"2025-04-04T11:09:09.093Z","avatar_url":"https://github.com/code-env.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Tidyup\n\n**tidyup** is a powerful command-line tool that organizes files in a specified directory into categorized subfolders. It offers multiple options to customize the organization process, ensuring your directories remain clean and structured.\n\n---\n\n## Features\n\n- Organizes files into subfolders by:\n  - **File Extensions** (e.g., `mp4`, `pdf`).\n  - **Starting Names** (e.g., `project-a`, `report`).\n  - **Creation Dates** (e.g., `2024-12-24`).\n- Handles file naming conflicts automatically.\n- Provides a detailed summary of the organization process.\n- Compatible with Windows, macOS, and Linux.\n\n---\n\n## Installation\n\nFirst, ensure you have Node.js installed on your system.\n\n1. Install `tidyup` globally via npm:\n\n   ```bash\n   npm install -g tidyup\n   ```\n\n2. Verify the installation:\n\n   ```bash\n   tidyup --version\n   ```\n\n---\n\n## Usage\n\nRun the `tidyup` command, specifying the directory to organize and the desired options.\n\n```bash\ntidyup [directory] [options]\n```\n\nIf no directory is specified, the current directory (`.`) is used by default.\n\n### Options\n\n- `--ext`: Organize files into folders based on their **file extensions**.\n- `--name`: Group files by their **starting names**.\n- `--date`: Group files by their **creation dates**.\n- `--ignore-dotfiles`: Ignore dotfiles when organizing.\n\n\u003e **Note**: Some of these options cannot be used together. For example, you cannot use `--ext` and `--name` simultaneously, but you can use `--ignore-dotfiles` with any one other option.\n\n---\n\n## Examples\n\n### Organize by File Extensions\n\n```bash\ntidyup /path/to/directory --ext\n```\n\nExample output:\n\n```\nOrganization Summary for '/path/to/directory':\n- Folder: mp4\n  - Created\n  - Files added: 3\n- Folder: pdf\n  - Already existed\n  - Files added: 1\n```\n\n### Group Files by Starting Names\n\n```bash\ntidyup /path/to/directory --name\n```\n\nExample output:\n\n```\nOrganization Summary for '/path/to/directory':\n- Folder: project-a\n  - Created\n  - Files added: 4\n- Folder: report\n  - Already existed\n  - Files added: 2\n```\n\n### Organize by Creation Dates\n\n```bash\ntidyup /path/to/directory --date\n```\n\nExample output:\n\n```\nOrganization Summary for '/path/to/directory':\n- Folder: 2024-12-23\n  - Created\n  - Files added: 2\n- Folder: 2024-12-24\n  - Already existed\n  - Files added: 3\n```\n\n### Organize by Name and Ignore Dotfiles\n```bash\ntidyup /path/to/directory --name --ignore-dotfiles\n```\n\nExample output:\n\n```\nOrganization Summary for '/path/to/directory':\n- Folder: project-a\n  - Created\n  - Files added: 4\n- Folder: report\n  - Already existed\n  - Files added: 2\n```\n\n### Invalid Option Combination\n\n```bash\ntidyup /path/to/directory --ext --name\n```\n\nError output:\n\n```\nThe --ext, --name, and --date options cannot be used together.\n```\n\n---\n\n## Development\n\n1. Clone the repository:\n\n   ```bash\n   git clone https://github.com/code-env/tidyup.git\n   ```\n\n2. Navigate to the project directory:\n\n   ```bash\n   cd tidyup\n   ```\n\n3. Install dependencies:\n\n   ```bash\n   npm install\n   ```\n\n4. Build the project:\n\n   ```bash\n   npm run build\n   ```\n\n5. Test locally:\n\n   ```bash\n   node ./dist/index.js \u003cdirectory\u003e [options]\n   ```\n\n---\n\n## Contributing\n\nWe welcome contributions! To contribute:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bug fix.\n3. Submit a pull request with your changes.\n\n---\n\n## License\n\nThis project is licensed under the **ISC License**. See the LICENSE file for more details.\n\n---\n\n## Author\n\n**tidyup** is developed and maintained by [Bossadi Zenith](https://github.com/code-env).\n\n---\n\nHappy organizing! 🎉\n\nLet me know if this aligns with your requirements or needs further customization.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-env%2Ftidyup","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcode-env%2Ftidyup","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcode-env%2Ftidyup/lists"}