{"id":25043623,"url":"https://github.com/0x-kys/flawa","last_synced_at":"2025-10-21T01:31:41.194Z","repository":{"id":258002364,"uuid":"871276956","full_name":"0x-kys/flawa","owner":"0x-kys","description":"Flawa generates Markdown docs from code files, so you don’t have to explain everything.","archived":false,"fork":false,"pushed_at":"2024-11-18T02:42:17.000Z","size":700,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"non-gh","last_synced_at":"2024-11-18T03:32:45.189Z","etag":null,"topics":["automation","cli","code-documentation","documentation","golang","llm","markdown","ollama"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/0x-kys.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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-10-11T16:08:11.000Z","updated_at":"2024-11-18T02:42:21.000Z","dependencies_parsed_at":"2024-11-18T08:58:53.898Z","dependency_job_id":null,"html_url":"https://github.com/0x-kys/flawa","commit_stats":null,"previous_names":["0x-kys/flawa"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x-kys%2Fflawa","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x-kys%2Fflawa/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x-kys%2Fflawa/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/0x-kys%2Fflawa/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/0x-kys","download_url":"https://codeload.github.com/0x-kys/flawa/tar.gz/refs/heads/non-gh","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237418684,"owners_count":19306926,"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":["automation","cli","code-documentation","documentation","golang","llm","markdown","ollama"],"created_at":"2025-02-06T04:57:53.692Z","updated_at":"2025-10-21T01:31:35.934Z","avatar_url":"https://github.com/0x-kys.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Flawa\n\n**Flawa** is a command-line tool designed to generate documentation from your code files, making it easier to understand and maintain projects. It comes with commands for listing files, generating documentation, and supporting autocompletion in various shells.\n\n## Installation\n\nTo get started, ensure you have **Golang** and **Ollama** installed, then set up Flawa with the following steps:\n\n1. **Install Golang**: [Golang installation guide](https://golang.org/doc/install)\n2. **Install Ollama**: Follow instructions at [Ollama](https://ollama.com/download)\n3. **Pull and Serve Ollama**:\n   ```sh\n   ollama pull qwen2.5-coder # or llama3.2\n   ollama serve\n   ```\n\n4. **Clone the Repository**:\n   ```sh\n   git clone https://github.com/0x-kys/flawa.git\n   # OR\n   git clone git@github.com:0x-kys/flawa.git\n   ```\n\n5. **Run Setup**:\n   ```sh\n   qwen2.5-coderh\n   cd flawa\n   chmod +x setup.sh\n   ./setup.sh install\n   ```\n\n   \u003e **To Uninstall**: Run `./setup.sh uninstall`\n\n## config.toml\n\n```toml\n[ignore]\ndirectories = [\".git\", \"node_modules\", \"venv\"] # Directories to ignore\nfiles = [\"anyrandomfile\"] # Files to ignore\n\n[ollama]\nmodel = \"qwen2.5-coder\" # Choose your preferred model ()\nstream = false # Keep this as false\nbase_prompt = '''WORKS BEST WITH DEFAULT''' # Default base prompt for the model\n```\n\n## Usage\n\n\u003e [!WARNING]\n\u003e **Disclaimer:** This tool utilizes pre-trained large language models (LLMs) with a general-purpose base prompt, which may result in variable or imperfect output quality. It’s recommended to thoroughly review generated documents to ensure accuracy and relevance before using them in any formal or critical context.\n\n### General Usage\n\nOnce installed, you can access Flawa with the `flawa` command. Here’s an overview:\n\n```sh\nflawa\n```\n\nThis shows a brief description, usage, available commands, and flags:\n\n```\nA command-line tool to generate docs from your code files\n\nUsage:\n  flawa [command]\n\nAvailable Commands:\n  completion  Generate the autocompletion script for the specified shell\n  generate    Generate documentation for a specific file\n  help        Help about any command\n  list        List files in the specified directory or current working directory if no directory is provided\n\nFlags:\n  -h, --help   help for flawa\n\nUse \"flawa [command] --help\" for more information about a command.\n```\n\n### Commands\n\n#### `list`\n\nThe `list` command displays the files in the specified directory. If no directory is provided, it lists files in the current working directory.\n\n```sh\n# List files in the current directory\nflawa list\n\n# List files in a specific directory\nflawa list path/to/directory\n```\n\n#### `generate`\n\nThe `generate` command creates documentation from code files. You can generate documentation for a single file or (in development) all files in a directory.\n\n```sh\n# Generate documentation for a specific file\nflawa generate -f path/to/file\n\n# Generate documentation for all files in a specific directory (under development)\nflawa generate -d path/to/directory\n```\n\n## Contributing\n\nFeel free to submit issues or pull requests if you have ideas for improvements or spot any bugs!\n\n## To-Do\n\n- [ ] [TEST] Nested subdirectories for `-d`\n- [ ] [REDACTOR] `cmd/generate.go` to use single function with conditionals\n- [ ] [FEATURE] Add markdown reading support (charmbracelet/glamour)\n    - `flawa read path/to/flawafied-file.md`\n\n\u003e **Note to Self**: Check todos on Tiddly.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x-kys%2Fflawa","html_url":"https://awesome.ecosyste.ms/projects/github.com%2F0x-kys%2Fflawa","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2F0x-kys%2Fflawa/lists"}