feat(cli): Add checking for git and gh CLI tools in GitHub mode

Closes #217

- Enable GitHub mode by default
- Add automatic checking for git and gh CLI tools when GitHub mode is enabled
- Disable GitHub mode if required tools are not available or not authenticated
- Update README.md with information about the new behavior
- Update tsconfig.json to exclude test files from build

Author: bhouston

packages/cli/README.md

@@ -52,47 +52,42 @@ MyCoder includes a GitHub mode that enables the agent to work with GitHub issues
 - Create PRs when work is complete
 - Create additional GitHub issues for follow-up tasks or ideas
 
-To enable GitHub mode:
+GitHub mode is **enabled by default** but requires the Git and GitHub CLI tools to be installed and configured:
 
-1. Via CLI option (overrides config file):
-
-```bash
-mycoder --githubMode true
-```
-
-2. Via configuration file:
+- Git CLI (`git`) must be installed
+- GitHub CLI (`gh`) must be installed and authenticated
 
-```js
-// mycoder.config.js
-export default {
-  githubMode: true,
-  // other configuration options...
-};
-```
+MyCoder will automatically check for these requirements when GitHub mode is enabled and will:
+- Warn you if any requirements are missing
+- Automatically disable GitHub mode if the required tools are not available or not authenticated
 
-To disable GitHub mode:
+To manually enable/disable GitHub mode:
 
-1. Via CLI option:
+1. Via CLI option (overrides config file):
 
 ```bash
-mycoder --githubMode false
+mycoder --githubMode true   # Enable GitHub mode
+mycoder --githubMode false  # Disable GitHub mode
 ```
 
 2. Via configuration file:
 
 ```js
 // mycoder.config.js
 export default {
-  githubMode: false,
+  githubMode: true,  // Enable GitHub mode (default)
   // other configuration options...
 };
 ```
 
 Requirements for GitHub mode:
 
+- Git CLI (`git`) needs to be installed
 - GitHub CLI (`gh`) needs to be installed and authenticated
 - User needs to have appropriate GitHub permissions for the target repository
 
+If GitHub mode is enabled but the requirements are not met, MyCoder will provide instructions on how to install and configure the missing tools.
+
 ## Configuration
 
 MyCoder is configured using a `mycoder.config.js` file in your project root, similar to ESLint and other modern JavaScript tools. This file exports a configuration object with your preferred settings.

packages/cli/src/commands/$default.ts

@@ -20,10 +20,9 @@ import { TokenTracker } from 'mycoder-agent/dist/core/tokens.js';
 import { SharedOptions } from '../options.js';
 import { captureException } from '../sentry/index.js';
 import { getConfigFromArgv, loadConfig } from '../settings/config.js';
-import { checkGitHubTools, getGitHubModeWarning } from '../utils/githubTools.js';
+import { checkGitCli } from '../utils/gitCliCheck.js';
 import { nameToLogIndex } from '../utils/nameToLogIndex.js';
 import { checkForUpdates, getPackageInfo } from '../utils/versionCheck.js';
-import { checkGitCli } from '../utils/gitCliCheck.js';
 
 import type { CommandModule, Argv } from 'yargs';
 
@@ -73,8 +72,14 @@ export const command: CommandModule<SharedOptions, DefaultArgs> = {
         if (!gitCliCheck.gitAvailable || !gitCliCheck.ghAvailable) {
           logger.warn('GitHub mode requires git and gh CLI tools to be installed.');
           logger.warn('Please install the missing tools or disable GitHub mode with --githubMode false');
+          // Disable GitHub mode if git or gh CLI is not available
+          logger.info('Disabling GitHub mode due to missing CLI tools.');
+          config.githubMode = false;
         } else if (!gitCliCheck.ghAuthenticated) {
           logger.warn('GitHub CLI is not authenticated. Please run "gh auth login" to authenticate.');
+          // Disable GitHub mode if gh CLI is not authenticated
+          logger.info('Disabling GitHub mode due to unauthenticated GitHub CLI.');
+          config.githubMode = false;
         }
       } else {
         logger.info('GitHub mode is enabled and all required CLI tools are available.');

packages/cli/src/options.ts

@@ -88,7 +88,8 @@ export const sharedOptions = {
   } as const,
   githubMode: {
     type: 'boolean',
-    description: 'Enable GitHub mode for working with issues and PRs',
+    description: 'Enable GitHub mode for working with issues and PRs (requires git and gh CLI tools)',
+    default: true,
   } as const,
   upgradeCheck: {
     type: 'boolean',

packages/cli/src/utils/gitCliCheck.ts

@@ -21,7 +21,7 @@ async function checkGitAvailable(): Promise<boolean> {
   try {
     await execAsync('git --version');
     return true;
-  } catch (error) {
+  } catch {
     return false;
   }
 }
@@ -33,7 +33,7 @@ async function checkGhAvailable(): Promise<boolean> {
   try {
     await execAsync('gh --version');
     return true;
-  } catch (error) {
+  } catch {
     return false;
   }
 }
@@ -45,7 +45,7 @@ async function checkGhAuthenticated(): Promise<boolean> {
   try {
     const { stdout } = await execAsync('gh auth status');
     return stdout.includes('Logged in to');
-  } catch (error) {
+  } catch {
     return false;
   }
 }

packages/cli/tsconfig.json

@@ -44,5 +44,6 @@
     "allowJs": false,
     "checkJs": false
   },
-  "include": ["src/**/*"]
+  "include": ["src/**/*"],
+  "exclude": ["src/**/*.test.ts", "src/**/*.spec.ts"]
 }