{"id":24742366,"url":"https://github.com/subh05sus/gyaanicli","last_synced_at":"2025-08-23T02:06:11.843Z","repository":{"id":270879447,"uuid":"890505927","full_name":"subh05sus/GyaaniCLI","owner":"subh05sus","description":"gyaani is an AI-powered terminal npm package that enhances your command-line experience with smart features. It assists with various tasks—from system insights to generating images—directly from your terminal, making your workflow faster and more efficient.","archived":false,"fork":false,"pushed_at":"2025-01-03T18:11:26.000Z","size":9338,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-08T17:14:47.659Z","etag":null,"topics":["cli","cli-app","flask","openai","react","react-inc","terminal-app","terminal-based"],"latest_commit_sha":null,"homepage":"https://gyaani.subhadip.me","language":"JavaScript","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/subh05sus.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-11-18T17:25:56.000Z","updated_at":"2025-01-27T09:58:19.000Z","dependencies_parsed_at":null,"dependency_job_id":"c5112977-45d3-4c9b-adac-2cb2e8602643","html_url":"https://github.com/subh05sus/GyaaniCLI","commit_stats":null,"previous_names":["subh05sus/gyaanicli"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/subh05sus/GyaaniCLI","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subh05sus%2FGyaaniCLI","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subh05sus%2FGyaaniCLI/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subh05sus%2FGyaaniCLI/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subh05sus%2FGyaaniCLI/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/subh05sus","download_url":"https://codeload.github.com/subh05sus/GyaaniCLI/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/subh05sus%2FGyaaniCLI/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":271732348,"owners_count":24811309,"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","status":"online","status_checked_at":"2025-08-23T02:00:09.327Z","response_time":69,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["cli","cli-app","flask","openai","react","react-inc","terminal-app","terminal-based"],"created_at":"2025-01-28T00:35:17.439Z","updated_at":"2025-08-23T02:06:11.817Z","avatar_url":"https://github.com/subh05sus.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Gyaani\n\n`gyaani` is an **AI-powered terminal npm package** that enhances your command-line experience with smart features. It assists with various tasks—from system insights to generating images—directly from your terminal, making your workflow faster and more efficient.\n\n---\n\n## Key Features\n\n- **Usage**: `$ gyaani [input]`\n- **Options**:\n    - `--help`: Display help documentation  \n    - `--version`: Show the current version  \n    - `--explain`: Provide explanations for concepts  \n    - `--sysinfo`: Display detailed system information  \n    - `--github`: Fetch GitHub repository details  \n    - `--generate`: Generate an image from a prompt  \n\nWith **AI capabilities**, `gyaani` brings powerful tools to your terminal, making it an essential assistant for developers, system administrators, and curious minds alike.\n\n---\n\n## Installation\n\nTo install `gyaani` globally, run:\n\n```bash\n$ npm install --global gyaani\n```\n\n---\n\n## How to Use\n\n### Basic Usage:\n\n```bash\n$ gyaani [input]\n```\n\n### Available Options\n\n- **`--help`**  \n  Display help documentation with available commands and usage examples.\n\n- **`--version`**  \n  Show the current version of `gyaani`.\n\n- **`--explain`**  \n  Explain concepts or technical terms in detail.\n\n- **`--sysinfo`**  \n  Display system information such as OS, CPU, and memory usage.\n\n- **`--github`**  \n  Fetch details about a GitHub repository, including contributors and issues.\n\n- **`--generate`**  \n  Generate an **AI-based image** from a given prompt.\n\n---\n\n## Examples\n\n```bash\n$ gyaani --help\n# Displays help information with available commands\n\n$ gyaani --version\n# Shows the current version of gyaani\n\n$ gyaani --explain \"What is OAuth?\"\n# Provides a detailed explanation of OAuth\n\n$ gyaani --sysinfo\n# Retrieves system details (CPU, memory, etc.)\n\n$ gyaani --github\n# Fetches data from a specified GitHub repository\n\n$ gyaani --generate \"an image of an orange muscular cat in a gym weightlifting 200 lbs\"\n# Generates an image based on the prompt\n```\n\n---\n\n## Why Use Gyaani?\n\n`gyaani` goes beyond being just another CLI tool—it’s your **AI-enhanced terminal companion**, designed to streamline tasks, simplify concepts, and provide quick access to insights.  \n\n- **Generate images**: Use creative prompts to generate AI-based images.  \n- **Explain concepts**: Have complex ideas explained in an easy-to-understand way.  \n- **Manage tasks efficiently**: From fetching system details to GitHub data, Gyaani has got you covered.  \n\nWith its AI-powered core, `gyaani` continuously learns and improves, adapting to your needs and making your terminal experience more engaging and productive.\n\n---\n\n## Screenshots\n\n1. **Landing Screen**  \n   ![Landing Screen](gyaani/Slide1.PNG)  \n\n2. **Command Execution**  \n   ![Working Demo](gyaani/Slide2.PNG)  \n\n3. **Explaining a Concept**  \n   ![Explaining Demo](gyaani/Slide3.PNG)  \n\n4. **Fetching GitHub Data**  \n   ![Getting Github Data](gyaani/Slide4.PNG)  \n\n5. **System Information Output**  \n   ![Getting System Data](gyaani/Slide5.PNG)  \n\n---\n\n## Local Setup for Contributors\n\n### Prerequisites\n\nTo run `Gyaani` locally, you’ll need:\n- [Node.js](https://nodejs.org/) and [npm](https://npmjs.com/) installed\n- [Python](https://python.org/) installed to set up the AI server\n\n### Setting up the AI Server\n\n1. **Navigate to the `ai-server` folder** in the repository.\n\n2. **Create a `.env` file** in the `ai-server` folder, and add your OpenAI API key:\n\n   ```env\n   OPENAI_API_KEY=sk-proj-xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx\n   ```\n\n3. **Set up a virtual environment** and install dependencies:\n\n   ```bash\n   # Install virtualenv if it's not already installed\n   python -m venv venv\n   source venv/bin/activate # On Windows, use `venv\\Scripts\\activate`\n   pip install -r requirements.txt\n   ```\n\n4. **Run the AI server**:\n\n   ```bash\n   python app.py\n   ```\n\nThe server should start at `http://127.0.0.1:5000`.\n\n### Setting up the `gyaani` React App\n\n1. **Navigate to the `gyaani` folder** in the repository.\n\n2. **Update `config.js`** in the `gyaani` folder with the local server URL:\n\n   ```javascript\n   export const apiURL = 'http://127.0.0.1:5000';\n   ```\n\n3. **Install dependencies and start the React app**:\n\n   ```bash\n   npm install\n   npm run dev\n   ```\n\nThe React app should now be running locally.\n\n---\n\n## Conclusion\n\n`gyaani` offers a **smarter way to interact with your terminal**, integrating AI to simplify tasks and generate creative content. Whether you’re looking for quick insights, system details, or even **AI-generated art**, `gyaani` makes it easy to get things done.\n\n```bash\n$ npm install --global gyaani\n```\n\nGive `gyaani` a try today and take your terminal game to the next level! 🚀\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubh05sus%2Fgyaanicli","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsubh05sus%2Fgyaanicli","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsubh05sus%2Fgyaanicli/lists"}