{"id":23853559,"url":"https://github.com/david-m-github/iminstant","last_synced_at":"2026-02-03T20:46:05.313Z","repository":{"id":268421511,"uuid":"904204641","full_name":"David-M-GitHub/ImInstant","owner":"David-M-GitHub","description":"Versatile and user-friendly command-line interface for managing and automating tasks on Windows systems. ","archived":false,"fork":false,"pushed_at":"2025-01-02T14:27:46.000Z","size":114,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-02T15:27:54.388Z","etag":null,"topics":["automation","management-system","shell","user-friendly","windows"],"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/David-M-GitHub.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-12-16T12:52:43.000Z","updated_at":"2025-01-02T14:27:50.000Z","dependencies_parsed_at":"2024-12-16T17:34:39.504Z","dependency_job_id":"46d7adbf-5169-4685-a737-be2e53d100d4","html_url":"https://github.com/David-M-GitHub/ImInstant","commit_stats":null,"previous_names":["david-m-github/iminstant"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/David-M-GitHub%2FImInstant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/David-M-GitHub%2FImInstant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/David-M-GitHub%2FImInstant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/David-M-GitHub%2FImInstant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/David-M-GitHub","download_url":"https://codeload.github.com/David-M-GitHub/ImInstant/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":232266951,"owners_count":18497151,"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","management-system","shell","user-friendly","windows"],"created_at":"2025-01-02T23:17:59.050Z","updated_at":"2026-02-03T20:46:05.273Z","avatar_url":"https://github.com/David-M-GitHub.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"![ImInstant](./img/github-header-image.png)\n\nWelcome to **ImInstant**, a powerful and intuitive command-line interface for managing and automating tasks. Designed with versatility and ease of use in mind, this project combines modularity, auto-completion, and a stylish interface to enhance your productivity.\n\n---\n\n# ✨ Key Features\n\n- **Modular Commands:** Each command is implemented as a separate Python file, simplifying extension and maintenance.\n- **Autocomplete:** Tab-completion for seamless command execution.\n- **Interactive Interface:** Modern, colorful, and user-friendly terminal output.\n- **Cross-Platform Support:** Built for Windows with expandability for Linux and macOS.\n- **Customizable Modules:** Easy to add or modify commands to fit your needs.\n\n---\n\n# 🚀 Getting Started\n\n## Prerequisites\n\n1. **Python 3.8+**\n   - Download and install Python from [python.org](https://www.python.org/).\n   - Ensure Python is added to your system's PATH.\n\n2. **Git** (optional but recommended)\n   - Download and install Git from [git-scm.com](https://git-scm.com/).\n\n## Clone the Repository\n\n```bash\n# Clone using Git\ngit clone https://github.com/David-M-GitHub/iminstant.git\ncd iminstant\n```\n\n## Create and Activate Virtual Environment\n\n```bash\n# Create a virtual environment\npython -m venv venv\n\n# Activate the virtual environment (OS-specific)\n# On Windows:\nvenv\\Scripts\\activate\n\n# On Linux/macOS:\nsource venv/bin/activate\n```\n\n## Install Dependencies\n\n```bash\n# Update PIP\npython -m pip install --upgrade pip\n\n# Install Requirements\npip install -r requirements.txt\n```\n\n---\n\n# 💻 Usage\n\n## Start the Program\n\n1. Launch the program:\n   ```bash\n   python main.py\n   ```\n\n2. Start typing commands! The following commands are included by default:\n   - `help`: Displays a list of available commands.\n   - `install \u003csoftware\u003e`: Installs software via Winget.\n   - `exit`: Exits the ImInstant console.\n   - `uninstall \u003csoftware\u003e`: Uninstalls specified software using Winget.\n   - `systeminfo`: Displays detailed system information.\n   - `clear`: Clears the console screen.\n   - `updateall`: Updates all applications to the latest version using Winget.\n   - `and more...`: See at `help`\n\n3. Autocomplete is available using the `TAB` key.\n\n## Example Session\n\n```plaintext\n┌───────────────────────────────────────────────────────────┐\n│ Welcome to ImInstant Command Line Interface               │\n├───────────────────────────────────────────────────────────┤\n│ Type 'help' to see available commands.                    │\n│ Type 'exit' to leave the console.                         │\n└───────────────────────────────────────────────────────────┘\n\niminstant\u003e help\nAvailable commands:\n  install\n  help\n  exit\n\niminstant\u003e install firefox\nInstalling firefox...\nfirefox has been successfully installed!\n\niminstant\u003e exit\nExiting ImInstant. Goodbye!\n```\n\n---\n\n# 📂 Project Structure\n\n```plaintext\niminstant/\n├── commands/\n│   ├── __init__.py       # Command folder initializer\n│   ├── install.py        # Command: install software\n│   ├── help.py           # Command: display all commands\n│   ├── exit.py           # Command: exit the console\n│   └── ....              #\n├── completer.py          # Autocomplete functionality\n├── main.py               # Main entry point\n├── requirements.txt      # Required dependencies\n└── README.md             # Documentation\n```\n\n---\n\n# 🔧 Extending ImInstant\n\n## Adding a New Command\n\n1. **Create a New Command File:**\n   Add a new `.py` file in the `commands/` directory. The file name becomes the command name.\n\n   Example: `commands/status.py`\n\n2. **Define the `run` Function:**\n   Each command file must define a `run(args)` function to process input arguments.\n\n   Example:\n   ```python\n   from colorama import Fore\n\n   description = \"Example Description.\"\n   usage = \"example\"\n\n   def run(args):\n       \"\"\"\n       Example command: Displays system status.\n       \"\"\"\n       print(f\"{Fore.GREEN}System is running smoothly!\")\n   \n   def complete(text):\n      \"\"\"\n      Auto-completion for the 'example' command.\n      \"\"\"\n      return []\n   ```\n\n3. **Run the Program:**\n   Your new command will automatically load and become available.\n\n   ```bash\n   python main.py\n   ```\n\n---\n\n# 🔜 Planned Features\n\n1. **Dynamic Argument Parsing:** Add support for flags and options, e.g., `install firefox --silent`.\n2. **Command Logging:** Maintain a history of executed commands and their output.\n3. **Cross-Platform Enhancements:** Extend compatibility to Linux and macOS.\n4. **Custom Themes:** Allow users to customize the appearance of the console interface.\n5. **Plugin System:** Enable external plugins for greater extensibility.\n6. **Integrated Update Checker:** Notify users when new updates are available for ImInstant or installed software. ✅ \n7. **Remote Command Execution:** Execute commands on remote systems via SSH.\n8. **Task Scheduling:** Schedule commands to run at specific times.\n9. **Dependency Management:** Automatically handle software dependencies during installation.\n10. **Command Aliases:** Let users define shortcuts for frequently used commands.\n\n---\n\n# 🤝 Contributing\n\nWe welcome contributions! Please follow these steps:\n\n1. Fork the repository.\n2. Create a new branch for your feature or bugfix.\n3. Commit your changes with clear messages.\n4. Submit a pull request for review.\n\n---\n\n# 📓 License\n\nThis project is licensed under the MIT License. See the `LICENSE` file for details.\n\n---\n\n# 📧 Contact\n\nFor support or questions, please contact:\n\n- Email: david@musa-innovation.com\n- GitHub: [David-M-GitHub](https://github.com/David-M-GitHub)\n\n---\n\nStart using **ImInstant** today and take command of your tasks effortlessly!\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavid-m-github%2Fiminstant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdavid-m-github%2Fiminstant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdavid-m-github%2Fiminstant/lists"}