https://github.com/ejfox/cli-markdown-tagger
Use an LLM to add tags to your markdown's frontmatter
https://github.com/ejfox/cli-markdown-tagger
cli llm markdown
Last synced: about 2 months ago
JSON representation
Use an LLM to add tags to your markdown's frontmatter
- Host: GitHub
- URL: https://github.com/ejfox/cli-markdown-tagger
- Owner: ejfox
- Created: 2024-09-19T21:13:31.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-24T19:04:31.000Z (over 1 year ago)
- Last Synced: 2025-03-19T20:05:32.617Z (about 1 year ago)
- Topics: cli, llm, markdown
- Language: JavaScript
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Markdown Tag Updater CLI Tool
This CLI tool automatically updates tags in the frontmatter of markdown files using AI-powered suggestions. It fetches a list of allowed tags from a specified URL and uses the OpenRouter API to suggest relevant tags based on the content of the markdown file.
## Features
- Fetches allowed tags from a specified URL
- Uses AI (via OpenRouter API) to suggest relevant tags based on file content
- Updates markdown frontmatter with suggested tags
- Supports custom OpenRouter models
- Preserves existing tags
## Prerequisites
- Node.js (v12 or higher recommended)
- npm (comes with Node.js)
- OpenRouter API key
## API Key Setup
To use this tool, you need an API key from OpenRouter. Follow these steps to obtain and set up your API key:
1. Go to [https://openrouter.ai/settings/keys](https://openrouter.ai/settings/keys)
2. If you don't have an account, create one and log in
3. Generate a new API key
Once you have your API key, you need to set it as an environment variable. Here's how to do it on macOS/Linux:
1. Open your `.zshrc` file in your preferred text editor. We recommend using nvim or VSCode:
```
nvim ~/.zshrc
```
or
```
code ~/.zshrc
```
2. Add the following lines at the end of the file:
```zsh
export OPENROUTER_API_KEY="your_api_key_here"
export OPENROUTER_BASE_URL="https://openrouter.ai/api/v1"
```
Replace "your_api_key_here" with your actual API key.
3. Save the file and exit the editor.
4. Apply the changes by running:
```
source ~/.zshrc
```
5. Verify that the variables are set correctly:
```
echo $OPENROUTER_API_KEY
echo $OPENROUTER_BASE_URL
```
These commands should print your API key and the base URL respectively.
After setting up your API key, restart your terminal for the changes to take full effect. If you're using the tool in an already open terminal, remember to run `source ~/.zshrc` or start a new terminal session.
## Installation
1. Clone this repository or download the script:
```
git clone https://github.com/yourusername/markdown-tag-updater.git
cd markdown-tag-updater
```
2. Install the required dependencies:
```
npm install yargs gray-matter axios openai dotenv
```
3. Create a `.env` file in the project root and add your OpenRouter API key:
```
OPENROUTER_API_KEY=your_api_key_here
```
## Usage
Basic usage:
```
node markdown-tag-updater.js -f path/to/your/markdown/file.md
```
Specify a custom tags URL:
```
node markdown-tag-updater.js -f path/to/your/markdown/file.md -u https://example.com/custom-tags.json
```
Use a different OpenRouter model:
```
node markdown-tag-updater.js -f path/to/your/markdown/file.md -m anthropic/claude-2
```
### Options
- `-f, --file`: Path to the markdown file (required)
- `-u, --tags-url`: URL of the JSON file containing tags (default: https://ejfox.com/tags.json)
- `-m, --model`: OpenRouter model to use (default: openai/gpt-3.5-turbo)
- `-h, --help`: Show help information
## How it Works
1. The tool reads the specified markdown file.
2. It fetches the list of allowed tags from the specified URL.
3. The content of the markdown file is sent to the OpenRouter API along with the list of allowed tags.
4. The API suggests relevant tags based on the content.
5. The tool updates the frontmatter of the markdown file with the suggested tags, preserving any existing tags.
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
This project is licensed under the MIT License - see the LICENSE file for details.