Skip to content

Latest commit

 

History

History
195 lines (132 loc) · 7.36 KB

README.md

File metadata and controls

195 lines (132 loc) · 7.36 KB
Raw

Qatam CLI

Qatam CLI logo

Table of Content

Introduction

Qatam CLI is a tool that combines commands from various services into a single CLI, allowing developers to focus on their actual work and increasing productivity.

Qatam CLI manages different Services:

  1. Windows OS
  2. Git
  3. GitHub

Prerequisites

For Qatam CLI usage:

  1. Windows 10/11 OS

  2. WinGet

    • The WinGet command-line tool is bundled with Windows 11 and modern versions of Windows 10 by default as the App Installer.

  3. PowerShell 7.4

    • Check PowerShell 7.4 installation status:

      • Type in the "Windows search box" PowerShell 7.

        • Alternatively, check by default PowerShell 7 is installed in C:\Program Files\PowerShell\7.

      • Open PowerShell 7 & type $PSVersionTable.PSVersion to check the version.

    • If it's not installed, you may install it via WinGet CLI:

      • Install the latest PowerShell 7 version: 
        winget install --id Microsoft.PowerShell --source winget
      • Or see other solutions

For Git operations usage:

For GitHub operations usage:

  • Git (least V 2.27.0)

    • Check Git installation status / version:

      git -v

  • GCM (Git Credential Manager)

    • By default, with Git V 2.27.0 & later, GCM is included.

Note

Both Git & GCM can be installed using the Qatam CLI. Thus, you ONLY need to consider the Qatam CLI requirements.

Install

  1. Open PowerShell 7.4

  2. Run the following:

    Install-Module -Name qatam-cli

Note

It will be installed under "C:\Users\Your-User-Name\Documents\PowerShell\Modules" or "C:\Users\Your-User-Name\OneDrive\Documents\PowerShell\Modules" directory.

Update

  1. Open PowerShell 7.4

  2. Run the following:

    Update-Module -Name qatam-cli

Uninstall

  1. Open PowerShell 7.4

  2. Run the following:

    Uninstall-Module -Name qatam-cli

Usage

Command Description
qatam [h | help] Or qatam Display all Qatam-CLI services
qatam <service> [h | help] Display all service's commands
qatam <service> <command> Execute the command

List of Qatam CLI services

Qatam CLI services
Command Description
w | windows Manage Windows OS Operations
g | git Manage Git Operations
gh | github Manage GitHub Operations

List of Qatam CLI commands

Operations for Windows OS
Command Description
cdir | create-dir Create a Local Directory
gdir | get-dir - User Provide a Local Directory's Path.
- The Existence of the Local Directory Gets Verified.
- Navigate to it.
bp | back-path Navigate to the Previous Path
h | help Display Windows OS Commands

Operations for Git
Command Description
v | version Get Installed Git version
upd | update Update Git
i | install Install Git
uni | uninstall Uninstall Git
bn | branch-name Rename the Main Branch of a Local Git Repository.
cc | config-cred Configure the Local Git Repository's Credintials (Username & E-mail).
h | help Display Git Commands

Operations for GitHub (Currently under development)
Command Description
c | create Create a remote GitHub repository
rm | remove Delete a remote GitHub repository
con | connect Create a link between local Git & remote GitHub repositories
h | help Display GitHub commands

Current status

This project is currently under development and testing. There are three main stages in progress: Windows OS, Git, and GitHub. Once these stages are completed, the CI/CD stage will begin, focusing on community support, bug fixes, user experience enhancements, new commands, and feature creation.

Support

Buy Me A Coffee

License

GNU Affero General Public License v3.0