Removing Projects¶
The thothctl remove project command allows you to remove projects that are tracked by ThothCTL. This helps you maintain a clean and organized development environment by removing projects that are no longer needed.
Command Syntax¶
Options¶
| Option | Description |
|---|---|
-pj, --project-name TEXT |
Project name to delete |
--help |
Show help message and exit |
Basic Usage¶
Removing a Project¶
To remove a project from ThothCTL tracking:
This command removes the project from ThothCTL's tracking system but does not delete the actual project files. It only removes the project's entry from the .thothcf.toml tracking file.
Understanding the Process¶
When you remove a project using the remove project command:
- ThothCTL checks if the project exists in its tracking system
- If the project exists, it removes the project's entry from the tracking file
- The project is no longer listed when you run
thothctl list projects - The actual project files remain untouched
Use Cases¶
Cleaning Up Old Projects¶
Remove projects that are no longer needed or maintained:
# List all projects to identify candidates for removal
thothctl list projects
# Remove an old project
thothctl remove project --project-name old-project
Project Reorganization¶
Remove a project from tracking before moving it to a different location or system:
# Remove the project from tracking
thothctl remove project --project-name project-to-move
# Now you can move or reorganize the project files
Project Retirement¶
Mark a project as retired by removing it from active tracking:
# Remove the project from tracking
thothctl remove project --project-name retired-project
# Optionally, move the project to an archive location
Fixing Tracking Issues¶
If a project's tracking information becomes corrupted or incorrect, you can remove it and re-add it:
# Remove the project from tracking
thothctl remove project --project-name problematic-project
# Re-initialize the project
thothctl init project --project-name problematic-project
Best Practices¶
- Verify Before Removing: Always verify that you're removing the correct project
- Backup Important Data: Consider backing up important project data before removing it from tracking
- Document Removals: Keep a record of removed projects for future reference
- Clean Up Related Resources: If a project has associated resources (e.g., in cloud environments), consider cleaning those up as well
- Inform Team Members: Notify team members when removing shared projects
Common Scenarios¶
Removing Multiple Projects¶
To remove multiple projects, run the command for each project:
thothctl remove project --project-name project1
thothctl remove project --project-name project2
thothctl remove project --project-name project3
Removing All Projects in a Space¶
To remove all projects in a space, first list the projects in that space, then remove each one:
# List projects to identify those in the space
thothctl list projects --show-space
# Remove each project in the space
thothctl remove project --project-name project1
thothctl remove project --project-name project2
Alternatively, you can use the remove space command with the --remove-projects flag to remove all projects in a space at once.
Removing a Project That Doesn't Exist¶
If you try to remove a project that doesn't exist in the tracking system, ThothCTL will display an error message: