Skip to content

Commit 8a95014

Browse files
committed
update docs + engines
1 parent d3c01dc commit 8a95014

2 files changed

Lines changed: 30 additions & 2 deletions

File tree

README.md

Lines changed: 29 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,13 @@ TaskMaster CLI was created to streamline the use of TaskMaster AI with an intuit
2727

2828
## 🚀 Getting Started
2929

30+
### Prerequisites
31+
32+
Before you begin, ensure you have the following installed:
33+
34+
- **Node.js**: `v22.8.0` or higher
35+
- **TaskMaster AI Core**: You can install it via the interactive CLI setup or manually. The minimum required version is `v0.23.0` or higher.
36+
3037
### Installation
3138

3239
Install TaskMaster CLI globally on your system:
@@ -35,6 +42,28 @@ Install TaskMaster CLI globally on your system:
3542
npm install -g taskmaster-cli
3643
```
3744

45+
### Configuration
46+
47+
TaskMaster CLI requires API keys to communicate with various AI providers.
48+
49+
1. Create a `.env` file in the root of your project by copying/renaming the `.env.example` file:
50+
2. Open the `.env` file and add your API keys.
51+
52+
```dotenv
53+
# API Keys (Required to enable respective provider)
54+
ANTHROPIC_API_KEY="your_anthropic_api_key_here" # Required: Format: sk-ant-api03-...
55+
PERPLEXITY_API_KEY="your_perplexity_api_key_here" # Optional: Format: pplx-...
56+
OPENAI_API_KEY="your_openai_api_key_here" # Optional, for OpenAI/OpenRouter models. Format: sk-proj-...
57+
GOOGLE_API_KEY="your_google_api_key_here" # Optional, for Google Gemini models.
58+
GEMINI_API_KEY="your_gemini_api_key_here"
59+
MISTRAL_API_KEY="your_mistral_key_here" # Optional, for Mistral AI models.
60+
XAI_API_KEY="YOUR_XAI_KEY_HERE" # Optional, for xAI AI models.
61+
AZURE_OPENAI_API_KEY="your_azure_key_here" # Optional, for Azure OpenAI models (requires endpoint in .taskmaster/config.json).
62+
OLLAMA_API_KEY="your_ollama_api_key_here" # Optional: For remote Ollama servers that require authentication.
63+
GITHUB_API_KEY="your_github_api_key_here" # Optional: For GitHub import/export features. Format: ghp_... or github_pat_...
64+
OPENROUTER_API_KEY="your_openrouter_api_key_here" # Optional: For OpenRouter models. Format: sk-proj-...
65+
```
66+
3867
### Standard Workflow
3968
4069
1. **Initialize a new project** using the dedicated command.
@@ -152,7 +181,6 @@ TMAI-CLI
152181
## ❤️ Acknowledgements & Contributing
153182
154183
This project would not have been possible without the **TaskMaster AI team**, as it is built entirely on their exceptional ecosystem.
155-
156184
We welcome contributions to improve the project! Whether you want to contribute to **TaskMaster AI Core** or **TaskMaster CLI**, feel free to make pull requests, report issues, or suggest new features.
157185
158186
### For Developers

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@
3232
"typescript"
3333
],
3434
"engines": {
35-
"node": "18.18.0"
35+
"node": "22.8.0"
3636
},
3737
"scripts": {
3838
"start": "bun dist/index.js",

0 commit comments

Comments
 (0)