{"id":27629290,"url":"https://github.com/deans-bradley/projecttools","last_synced_at":"2025-04-23T15:16:02.596Z","repository":{"id":285951171,"uuid":"959711800","full_name":"deans-bradley/ProjectTools","owner":"deans-bradley","description":"The ProjectTools module is a collection of PowerShell functions designed to simplify navigating between your projects and integrating with tools like VS Code.","archived":false,"fork":false,"pushed_at":"2025-04-23T05:54:42.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-04-23T15:15:58.329Z","etag":null,"topics":["powershell"],"latest_commit_sha":null,"homepage":"","language":"PowerShell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/deans-bradley.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,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-04-03T08:23:02.000Z","updated_at":"2025-04-23T05:54:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"ab005096-27af-410a-a362-80845a8e6f56","html_url":"https://github.com/deans-bradley/ProjectTools","commit_stats":null,"previous_names":["deans-bradley/projecttools"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2FProjectTools","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2FProjectTools/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2FProjectTools/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/deans-bradley%2FProjectTools/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/deans-bradley","download_url":"https://codeload.github.com/deans-bradley/ProjectTools/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250457791,"owners_count":21433734,"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":["powershell"],"created_at":"2025-04-23T15:16:01.856Z","updated_at":"2025-04-23T15:16:02.571Z","avatar_url":"https://github.com/deans-bradley.png","language":"PowerShell","readme":"# ProjectTools PowerShell Module\n\n**Key Features**:\n- **Navigate to project directories** with ease.\n- **Open projects in VS Code** with a single command.\n- **List all available projects** in your workspace for easy reference.\n\n## Setup\n\nTo get started with the **ProjectTools** module, follow these steps:\n\n### Prerequisites\n- PowerShell 5.1 or higher.\n- **VS Code** installed (optional, for opening projects in VS Code).\n\n### Installation Steps:\n\n1. **Clone or Download the Repository**:\n   Download the project files to your local machine.\n\n2. **Place the Module in Your PowerShell Modules Folder**:\n   Move the `ProjectTools` folder to the following directory:\n   - `C:\\Users\\\u003cYourUsername\u003e\\Documents\\WindowsPowerShell\\Modules\\ProjectTools\\`\n   (Replace `\u003cYourUsername\u003e` with your actual Windows username.)\n\n3. **Import the Module**:\n   Open your PowerShell profile file (`Microsoft.PowerShell_profile.ps1`) and add the following line:\n   ```powershell\n   Import-Module ProjectTools\n   ```\n   This ensures that the module is loaded every time you open PowerShell.\n\n4. **Reload PowerShell**:\n   Restart your PowerShell terminal or run the following to reload your profile:\n   ```powershell\n   . $PROFILE\n   ```\n\n---\n\n## Usage Guide\n\nOnce the module is installed and loaded, you can start using the following commands:\n\n### 1. **`pt open \u003cProjectName\u003e`**\n\nThis command allows you to navigate directly to the directory of the specified project.\n\n#### Syntax:\n```powershell\npt open \u003cProjectName\u003e\n```\n\n#### Example:\n```powershell\npt open MyApp\n```\nThis will change the directory to `MyApp` within your defined project structure.\n\n---\n\n### 2. **`pt open \u003cProjectName\u003e -code`**\n\nThis command works like `pt open`, but also opens the project in **VS Code** using the `-code` flag.\n\n#### Syntax:\n```powershell\npt open \u003cProjectName\u003e -code\n```\n\n#### Example:\n```powershell\npt open MyApp -code\n```\nThis will change to the `MyApp` project directory and open the project in **VS Code**.\n\nWe can also simply write the code flag as `-c`.\n```powershell\npt open MyApp -c\n```\n\n---\n\n### 3. **`pt show`**\n\nThis command will list all available projects that are detected within your configured workspace. It provides an overview of all projects stored in your `repos` directories.\n\n#### Example:\n```powershell\npt show\n```\nThis will display a list of all available projects along with their paths.\n\n---\n\n## Troubleshooting\n\n- **VS Code isn't opening the project**: Ensure that **VS Code** is installed and the `code` command is available in your system's PATH.\n  - Test the `code` command by typing `code --version` in the terminal. If it’s not recognized, refer to the [VS Code installation guide](https://code.visualstudio.com/docs/setup/setup-overview) to ensure it's correctly installed and added to the PATH.\n\n- **Projects not showing**: If projects are not appearing, run `pt show` to check that the module is correctly detecting your project directories. Ensure that your project structure follows the expected format: `C:\\Users\\\u003cYourUsername\u003e\\Work\\\u003cCompany\u003e\\repos\\\u003cProjectName\u003e`.\n\n---\n\n## License\n\nThis project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeans-bradley%2Fprojecttools","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdeans-bradley%2Fprojecttools","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdeans-bradley%2Fprojecttools/lists"}