{"id":18668298,"url":"https://github.com/markis/ask-the-code","last_synced_at":"2025-10-19T18:58:30.656Z","repository":{"id":256668318,"uuid":"851620507","full_name":"markis/ask-the-code","owner":"markis","description":null,"archived":false,"fork":false,"pushed_at":"2024-09-17T13:23:12.000Z","size":567,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-12-27T18:26:44.890Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/markis.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","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-03T12:33:21.000Z","updated_at":"2024-09-17T13:23:10.000Z","dependencies_parsed_at":"2024-11-07T08:42:39.751Z","dependency_job_id":"cfca5015-a181-464c-9fbb-f520635bc185","html_url":"https://github.com/markis/ask-the-code","commit_stats":null,"previous_names":["markis/ask-the-code"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Fask-the-code","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Fask-the-code/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Fask-the-code/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/markis%2Fask-the-code/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/markis","download_url":"https://codeload.github.com/markis/ask-the-code/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239498661,"owners_count":19648918,"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":[],"created_at":"2024-11-07T08:42:11.614Z","updated_at":"2025-10-19T18:58:30.647Z","avatar_url":"https://github.com/markis.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ask the Code\n\nA CLI tool for asking questions about documentation in a repository using AI-powered semantic search and retrieval-augmented generation (RAG).\n\n-----\n\n## Features\n\n- **Semantic Search**: Index and search through markdown documentation using ChromaDB and FlagEmbedding\n- **AI-Powered Answers**: Get contextual answers to questions about your documentation using Ollama\n- **Repository-Aware**: Automatically indexes documentation files in your repository\n- **Multiple Commands**: Create indexes, search sources, and ask natural language questions\n- **Reranking**: Uses FlagEmbedding reranker for improved search relevance\n\n## Table of Contents\n\n- [Installation](#installation)\n- [Usage](#usage)\n- [Commands](#commands)\n- [Configuration](#configuration)\n- [License](#license)\n\n## Installation\n\n```console\npip install git+https://github.com/markis/ask-the-code.git\n```\n\n## Usage\n\nFirst, create an index of your documentation:\n\n```console\nask create\n```\n\nThen ask questions about your documentation:\n\n```console\nask \"How do I configure the application?\"\n```\n\nOr search for specific information:\n\n```console\nask search \"configuration settings\"\n```\n\n## Commands\n\n- `ask create [--repo PATH] [--glob PATTERN]` - Create and index the knowledge store\n- `ask \"question\"` - Ask a question about the documentation\n- `ask search \"query\"` - Search for sources matching a query\n- `ask clean` - Clean up the data directory\n\n### Options\n\n- `--repo, -r PATH` - The repository path (defaults to current directory)\n- `--glob, -g PATTERN` - The glob pattern to match files (defaults to `**/*.md`)\n\n## Configuration\n\nThe tool uses Ollama for language model inference and requires:\n\n- Ollama running locally or accessible via URL\n- A compatible language model (configurable via settings)\n- ChromaDB for vector storage\n- FlagEmbedding for text embeddings and reranking\n\n## License\n\n`ask-the-code` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkis%2Fask-the-code","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmarkis%2Fask-the-code","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmarkis%2Fask-the-code/lists"}