Menu ▾ ▴

System Startup Guide

Robert Trenaman

System Startup Guide

Welcome to GitHub Commander. This guide will help you initialize the system and get started with managing your GitHub repositories.

Quick Start

Prerequisites Check

Before launching GitHub Commander, ensure you have:

  • Python 3.8 or higher - Required for the application
  • Git - Required for Git operations
  • GitHub Account - Required for GitHub integration

Verify your system:

python3 --version
git --version

Installation

  1. Clone or Download:
    bash git clone https://github.com/AutoBotSolutions/GitHub-Commander.git cd GitHub-Commander

  2. Install Dependencies:
    bash python3 -m venv venv source venv/bin/activate pip install -r requirements.txt

  3. Launch System:
    bash python main.py

Initial Configuration

Step 1: Authentication

GitHub Commander requires authentication to access GitHub features.

Generate GitHub Token:

  1. Go to GitHub.com
  2. Click profile picture → Settings
  3. Developer settings → Personal access tokens → Tokens (classic)
  4. Click "Generate new token (classic)"
  5. Enter note: "GitHub Commander"
  6. Select scopes:
  7. repo - Full control of repositories
  8. workflow - Update GitHub Actions
  9. delete_repo - Delete repositories
  10. Click "Generate token"
  11. Copy the token

Add Token to GitHub Commander:

  1. Click Settings in the main menu (or press Ctrl+,)
  2. Find GitHub Token field
  3. Paste your token
  4. Click Save

Step 2: Git Configuration

Configure your Git identity for commits:

  1. Go to Settings
  2. Find Git Configuration section
  3. Enter:
  4. User Name: Your name
  5. User Email: Your email
  6. Click Save

Step 3: Default Directory

Set your preferred clone directory:

  1. Go to Settings
  2. Find Clone Directory
  3. Enter path (default: ~/github-projects)
  4. Click **Save`

First-Time Operations

Browse Your Repositories

  1. After authentication, your repositories appear in the list
  2. Click on a repository to view details
  3. The info panel shows repository information

Clone a Repository

Method 1: From Repository List

  1. Right-click on a repository
  2. Select Clone
  3. Choose destination folder
  4. Click Clone

Method 2: From Git Panel

  1. Go to Git Panel
  2. Enter repository URL
  3. Choose destination folder
  4. Click Clone

Upload Files

Method 1: Drag and Drop

  1. Select a repository
  2. Navigate to Local File Browser
  3. Select files
  4. Drag to GitHub File Browser
  5. Enter commit message
  6. Click Upload

Method 2: Context Menu

  1. Right-click file in Local Browser
  2. Select Upload to GitHub
  3. Choose destination
  4. Enter commit message
  5. Click Upload

Create a Wiki Page

  1. Select a repository
  2. Go to Wiki Panel
  3. Click Create New Page
  4. Enter page title
  5. Write content in Markdown
  6. Click Save Page

Deploy to GitHub Pages

  1. Select a repository
  2. Go to Pages Panel
  3. Configure:
  4. Source Branch: main
  5. Source Directory: / (or specific folder)
  6. Custom Domain: (optional)
  7. Click Enable Pages
  8. Click Deploy to upload site files

Common First Tasks

1. Set Up Your Workspace

  • Configure default clone directory
  • Set up Git credentials
  • Customize UI settings (theme, font size)

2. Manage Your Repositories

  • Browse existing repositories
  • Clone frequently used repos
  • Create new repositories as needed

3. Establish Workflows

  • Set up feature branches
  • Configure commit message preferences
  • Set up keyboard shortcuts for efficiency

4. Document Your Projects

  • Create wiki pages for documentation
  • Set up GitHub Pages for project websites
  • Write README files

5. Automate Deployments

  • Configure GitHub Actions workflows
  • Set up package publishing
  • Create release templates

System Overview

Main Interface Components

Navigation Tabs:

  • Git Panel - Clone, commit, push, pull, branches
  • GitHub File Browser - Browse repository contents
  • Local File Browser - Browse local files
  • Wiki Panel - Manage repository wikis
  • Pages Panel - Deploy GitHub Pages
  • Packages Panel - Upload packages
  • Releases Panel - Create releases

Menu Options:

  • File - New repository, settings
  • Edit - Preferences
  • View - Panel selection
  • Help - Documentation

Keyboard Shortcuts

Essential shortcuts:

  • Ctrl+, - Settings
  • Ctrl+N - New repository
  • Ctrl+S - Save
  • Ctrl+P - Push
  • Ctrl+L - Pull
  • Alt+1-7 - Switch panels

See Keyboard Shortcuts for complete list.

Troubleshooting

Authentication Issues

Problem: "Failed to authenticate"

Solutions:

  • Verify token is correct
  • Check token has required scopes
  • Regenerate token if expired
  • Check internet connection

Clone Issues

Problem: "Clone failed"

Solutions:

  • Verify repository URL
  • Check write permissions
  • Ensure sufficient disk space
  • Check internet connection

Upload Issues

Problem: "Upload failed"

Solutions:

  • Verify authentication
  • Check file size (< 100 MB)
  • Ensure write access to repository
  • Check file path is valid

Wiki Issues

Problem: "Failed to upload wiki page"

Solutions:

  • Enable wiki in repository settings
  • Verify file is valid Markdown
  • Check authentication
  • Ensure internet connection

Next Steps

After completing startup:

  1. Explore Features - Try different panels and features
  2. Read Documentation - See comprehensive guides for each feature
  3. Customize Settings - Configure to your preferences
  4. Learn Shortcuts - Improve efficiency with keyboard shortcuts
  5. Join Community - Contribute and get help

Getting Help

  • Documentation: See Wiki
  • Issues: Report bugs on GitHub Issues
  • Support: Email autobotsolution@gmail.com

System Status

After completing startup, verify:

  • [ ] GitHub token configured
  • [ ] Git credentials set
  • [ ] Default directory configured
  • [ ] Can view repositories
  • [ ] Can clone a repository
  • [ ] Can upload files
  • [ ] Can create wiki pages

System Version: 1.0.0
Owner: Robert Trenaman
Company: (Software Customs) Auto Bot Solution
Email: autobotsolution@gmail.com
Location: Flushing, MI

Welcome to the future of GitHub management.

auth0 logo