https://github.com/pavanad/beegen
BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.
https://github.com/pavanad/beegen
ai-assistant automation cli code-snippets data-anonymization developer-tools faiss gemini generative-ai langchain llama mock-api ollama openai readme-generator semantic-search terminal-chat translation-tool
Last synced: 3 months ago
JSON representation
BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.
- Host: GitHub
- URL: https://github.com/pavanad/beegen
- Owner: pavanad
- License: mit
- Created: 2024-05-24T00:51:04.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2025-04-11T22:18:55.000Z (9 months ago)
- Last Synced: 2025-09-25T14:03:28.543Z (3 months ago)
- Topics: ai-assistant, automation, cli, code-snippets, data-anonymization, developer-tools, faiss, gemini, generative-ai, langchain, llama, mock-api, ollama, openai, readme-generator, semantic-search, terminal-chat, translation-tool
- Language: Python
- Homepage:
- Size: 407 KB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
BeeGen is an intelligent command-line tool designed to assist developers with everyday tasks, leveraging the power of generative AI.
## BeeGen
With Beegen, you can streamline your development process, improve code quality, and automate various aspects of project creation and management.
## Features
- **Mock APIs:** Quickly create and run mock API servers.
- **Sensitive Data Anonymization:** Use generative AI to mask identifiable information and ensure privacy.
- **Vector Store Generation:** Create a local vector store using FAISS for projects that require semantic search.
- **README Generator:** Automatically generate a detailed README file for your projects.
- **Translation:** Quickly translate text between different languages.
- **Code Snippets:** Add, list, remove, and use code snippets directly from the command line.
- **AI Chat Interface:** Interact with language models in a terminal-based chat.
## Installation
You can install BeeGen in three ways:
[PyPI](https://pypi.org/project/beegen/)
```bash
pip install beegen
```
Directly from the repository using [poetry](https://python-poetry.org/)
```bash
poetry install
```
Using pipx (recommended):
```bash
pipx install beegen
```
Why `pipx`?
`pipx` installs BeeGen in an isolated environment, avoiding conflicts with other Python packages on your system. This is ideal for command-line tools.
## Usage
Here are a few examples of how you can use BeeGen for daily tasks:
### Configure
Configure the LLM and access keys for usage.
```bash
beegen configure
```
Supported models include:
- **OpenAI:** Requires a valid OpenAI API key.
- **Ollama:** You need to install the Ollama CLI tool locally and download the desired model for it to work. More details can be found at [Ollama's official site](https://ollama.com/).
- **Gemini:** You can use the free model with a personal key. For more information, visit [Gemini's official site](https://aistudio.google.com/).
### Create a Mock API
Generate a configuration file for a mock API:
```bash
beegen mock create
```
**Mockefile (template)**
```yaml
authentication:
key: 20s7ILRwS9eMU8sXQ1sT9WaxFQTJwK5usCz3P_Ium6E
name: X-API-Key
type: api_key
description: BeeGen mockfile API example
endpoints:
- access: public
method: GET
path: /users
response:
body:
- email: john.doe@example.com
id: 1
name: John Doe
- email: jane.doe@example.com
id: 2
name: Jane Doe
status: 200
- access: protected
method: POST
path: /user
request:
- description: The user ID
name: id
type: int
- description: The user name
name: name
type: str
- description: The user email
name: email
```
Run the mock API server:
```bash
beegen mock run
```
### Anonymize Sensitive Data
Use the following command to anonymize sensitive data with generative AI to ensure privacy by masking identifiable information:
```bash
beegen smart anonymize-data ""
```
Anonymize sensitive data in files:
```bash
beegen smart anonymize-data --file data.txt
```
### Create a Vector Store
Build a local vector store from specific files or directories:
```bash
beegen smart create-vectorstore
```
### Generate a README
Automatically generate a detailed README file for your project:
```bash
beegen smart readme
```
### Generate a Regex
Generate a regular expression based on the provided value:
```bash
beegen smart regex "email@email.com" --language python
```
### Full List of Commands
To view the complete list of available commands, run:
```bash
beegen list
```
## Contributing
Contributions to BeeGen are welcome! If you find a bug, have a feature request, or want to improve the code, please submit a pull request.
## License
BeeGen is licensed under the MIT License. See the [LICENSE](/LICENSE) file for more information.