taiga-cli is a command-line interface (CLI) tool designed to interact with a Taiga instance, an agile project management platform. This CLI allows users to manage configurations, projects, sprints, and user stories efficiently and quickly from the terminal.
-
Clone the repository:
git clone https://github.com/dhabyx/python-taiga-cli.git cd taiga-cli -
Install the tool: Use
pipto install the project as a global CLI application:pip install .This will install the tool and set up the
taigacommand to be executed from anywhere in your terminal. -
Verify the installation:
taiga --help
If you see the help menu, everything is set!
-
Update the tool: If you make local changes or want to update from the repository, reinstall it:
pip install --upgrade . -
Uninstall the tool: If you need to remove the CLI, use:
pip uninstall taiga-cli
Set up the server and user credentials.
taiga configFollow the interactive instructions to configure the Taiga server and user credentials.
Authenticate with your Taiga instance.
taiga login-
List your own projects:
taiga project ls
-
List all projects:
taiga project ls --all
-
Show default project:
taiga project default
-
Set a project as the default:
taiga project set-default <project-slug>
-
Set a sprint as the default:
taiga sprint set-default <sprint-slug>
-
List sprints of the default project:
taiga sprint ls
-
List sprints of a specific project:
taiga sprint ls --project=<project-slug>
-
View user statistics for a sprint:
taiga sprint user-stats
-
View statistics of a specific user:
taiga sprint user-stats --user=<username>
-
View statistics for all users:
taiga sprint user-stats --all-users
-
View statistics for a specific project:
taiga sprint user-stats --project=<project-slug>
-
View statistics for a specific sprint:
taiga sprint user-stats --sprint=<sprint-slug>
-
List user stories for a sprint:
taiga sprint user-stories
-
List stories for a specific user:
taiga sprint user-stories --user=<username>
-
List stories for all users:
taiga sprint user-stories --all-users
-
List your own stories:
taiga stories ls
-
List stories from all sprints:
taiga stories ls --all-sprints
-
Filter stories by user:
taiga stories ls --user=<username>
-
Filter stories by status:
taiga stories ls --status=open taiga stories ls --status=closed
-
Filter stories by sprint:
taiga stories ls --sprint=<sprint-slug>
-
Filter stories by a specific project:
taiga sprint user-stats --project=<project-slug>
taiga-cli stores its configuration in a file on the user's system. This configuration includes details such as the Taiga server, user credentials, and default values for projects and sprints.
The configuration file is located in the following paths depending on the operating system:
-
Linux:
~/.config/taiga-cli/config.json -
macOS:
~/Library/Application Support/taiga-cli/config.json -
Windows: (Explicit support for Windows is not designed, but you could adapt it).
If you want to reset all stored configuration and restart the tool:
-
Delete the configuration file:
- On Linux:
rm ~/.config/taiga-cli/config.json - On macOS:
rm ~/Library/Application\\ Support/taiga-cli/config.json
- On Linux:
-
Recreate the configuration: After deleting the file, running
taiga configwill prompt you to re-enter the details:taiga config
Deleting this configuration file:
- Resets the server, credentials, and any configured default values.
- Does not affect data stored in the Taiga instance you are using.
To view all available options and commands:
taiga --helpFor a specific command:
taiga <command> --help-
Fork this repository.
-
Create a new branch:
git checkout -b feature/new-functionality
-
Make changes and commit:
git commit -m "Add new functionality" -
Push and open a Pull Request.
taiga-cli is under the MIT License. See the LICENSE file for more information.
If you have further improvements or additional details, let me know!