{"id":19750101,"url":"https://github.com/agentops-ai/spellcaster","last_synced_at":"2025-09-13T07:14:34.869Z","repository":{"id":255954145,"uuid":"853968512","full_name":"AgentOps-AI/Spellcaster","owner":"AgentOps-AI","description":"AI agent to automatically check grammar and spelling on documentation files","archived":false,"fork":false,"pushed_at":"2024-09-24T00:10:54.000Z","size":6856,"stargazers_count":84,"open_issues_count":3,"forks_count":7,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-04-03T11:49:36.119Z","etag":null,"topics":["agent","agentops","ai","grammar","grammar-checker","grammarly","spelling","spelling-correction"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AgentOps-AI.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}},"created_at":"2024-09-08T03:23:05.000Z","updated_at":"2025-03-29T09:45:05.000Z","dependencies_parsed_at":"2024-09-13T01:29:23.504Z","dependency_job_id":"0c1f22c1-f989-4f5d-aff7-df668a2dadbb","html_url":"https://github.com/AgentOps-AI/Spellcaster","commit_stats":null,"previous_names":["areibman/spellcaster","agentops-ai/spellcaster"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentOps-AI%2FSpellcaster","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentOps-AI%2FSpellcaster/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentOps-AI%2FSpellcaster/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AgentOps-AI%2FSpellcaster/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AgentOps-AI","download_url":"https://codeload.github.com/AgentOps-AI/Spellcaster/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248198889,"owners_count":21063628,"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":["agent","agentops","ai","grammar","grammar-checker","grammarly","spelling","spelling-correction"],"created_at":"2024-11-12T02:30:07.361Z","updated_at":"2025-04-10T10:11:58.643Z","avatar_url":"https://github.com/AgentOps-AI.png","language":"Python","readme":"\u003cp align=\"center\"\u003e\n  \u003cimg src=\"assets/spellcasterlogo.png\" alt=\"Spellcaster Logo\" width=\"300\"/\u003e\n\u003c/p\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eAI spelling and grammar checker for documentation\u003c/em\u003e\n\u003c/p\u003e\n\n\n\u003cp align=\"center\"\u003e\n\u003ca href=\"https://twitter.com/agentopsai/\"\u003e🐦 Twitter\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://discord.gg/a4VQ23Aps5\"\u003e📢 Discord\u003c/a\u003e\n\u003cspan\u003e\u0026nbsp;\u0026nbsp;•\u0026nbsp;\u0026nbsp;\u003c/span\u003e\n\u003ca href=\"https://agentops.ai/?spellcaster\"\u003e🖇️ AgentOps\u003c/a\u003e\n\u003c/p\u003e\n\n[![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n\nSpellcaster is an open-source CLI tool that uses AI to improve your codebase's documentation. It scans repositories for:\n\n- Grammar errors\n- Spelling mistakes\n- Issues in code examples\n\nSpellcaster helps identify potential problems to help you write clear, concise, and professional documentation.\n\n\nhttps://github.com/user-attachments/assets/60dbfdb1-d5a6-4dfd-9707-37e60d60b24e\n\n\nTo run Spellcaster:\n```bash\npip install spellcaster\nspellcaster -d /path/to/your/docs/directory/\n```\n\n![Screenshot](assets/screenshot.png)\n\n\n## 🦉 Features\n\n* Grammar and Spelling Checks: Spellcaster reviews your documentation and comments to ensure they are clear, correct, and professional.\n* Comprehensive File Scanning: Spellcaster reads across multiple file formats (Markdown, plain text, etc.) to detect issues.\n\n## Installation\n\n1. Install package:\n\n   ```bash\n   pip install spellcaster\n   ```\n\n2. Set up environment variables:\n\n   Create a `.env` file in your project root and add the following variables:\n\n   ```\n   AGENTOPS_API_KEY=your_agentops_api_key\n   ANTHROPIC_API_KEY=your_anthropic_api_key\n   OPENAI_API_KEY=your_openai_api_key\n   GROQ_API_KEY=your_groq_api_key\n   ```\n\nSpellcaster uses AgentOps for cost and latency tracking. You can sign up for an API key [here](https://app.agentops.ai/).\n\nReplace `your_*_api_key` with your actual API keys for each service.\n\n### Usage\n\nTo run Spellcaster:\n\n1. In your terminal, use the following command structure:\n\n   ```bash\n   spellcaster [options]\n   ```\n\n   Options:\n   - `-d`, `--directory`: The directory to scan\n   - `-u`, `--url`: The GitHub repository URL to clone and scan\n   - `-l`, `--llm_provider`: The LLM provider to use (choices: claude, sonnet, 3.5, gpt4o, gpt4, gpt3.5; default: MODEL from config)\n   - `-p`, `--proper_nouns`: A string of proper nouns to include in the prompt (default: \"* Llama3.1-70B\\n* Cerebras\\n* Cohere\\n* OpenAI\\n* AgentOps\\n* Spellcaster\")\n   - `-f`, `--file_types`: File types to scan (default: from FILE_TYPES in config)\n   - `-m`, `--max_files`: Maximum number of files to scan (default: MAX_FILES from config)\n\n2. Examples:\n\n   Scan a local directory with custom LLM provider:\n   ```bash\n   spellcaster --directory /path/to/your/docs --llm_provider gpt4\n   ```\n   \n   Scan a GitHub repository:\n   ```bash\n   spellcaster --url https://github.com/username/repo\n   ```\n\n3. Spellcaster will analyze the specified directory or repository and output any detected issues, along with suggestions for fixing them.\n\n### Configuration\n\nYou can customize Spellcaster's behavior by adjusting the `config.py` file:\n\n- `FILE_TYPES`: A list of file extensions to scan. By default, it includes `.mdx` and `.md` files. You can add or remove file extensions as needed.\n- `MAX_FILES`: The maximum number of files to scan. By default, it's set to 500. You can change this number to suit your needs.\n- `MODEL`: The default LLM provider to use. Model list available [here](https://models.litellm.ai).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentops-ai%2Fspellcaster","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fagentops-ai%2Fspellcaster","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fagentops-ai%2Fspellcaster/lists"}