better readmes.

Author: bhouston

CONTRIBUTING.md

@@ -166,4 +166,4 @@ This project and everyone participating in it is governed by our Code of Conduct
 3. Update changelog entries
 4. Tag releases appropriately
 
-Thank you for contributing to MyCoder! 👍
+Thank you for contributing to MyCoder! 👍

README.md

@@ -1,12 +1,10 @@
 # MyCoder
 
-An open-source mono-repository containing the MyCoder agent and cli.
-
-!NOTE: To get started with the mycoder agent, [please see the CLI package](packages/cli)
+Command-line interface for AI-powered coding tasks. Full details available on the main [MyCoder.ai website](https://mycoder.ai) and the [Official MyCoder.Ai Docs website](https://docs.mycoder.ai).
 
 ## Features
 
-- 🤖 **AI-Powered**: Leverages Anthropic's Claude and OpenAI models for intelligent decision making
+- 🤖 **AI-Powered**: Leverages Anthropic's Claude, OpenAI models, xAI/Grok, Mistral AI, and Ollama for intelligent coding assistance
 - 🛠️ **Extensible Tool System**: Modular architecture with various tool categories
 - 🔄 **Parallel Execution**: Ability to spawn sub-agents for concurrent task processing
 - 📝 **Self-Modification**: Can modify code, it was built and tested by writing itself
@@ -16,6 +14,30 @@ An open-source mono-repository containing the MyCoder agent and cli.
 
 Please join the MyCoder.ai discord for support: https://discord.gg/5K6TYrHGHt
 
+## Installation
+
+```bash
+npm install -g mycoder
+```
+
+For detailed installation instructions for macOS and Linux, including how to set up Node.js using NVM, [see our Getting Started guide](https://docs.mycoder.ai/docs/getting-started/).
+
+## Usage
+
+```bash
+# Interactive mode
+mycoder -i
+
+# Run with a prompt
+mycoder "Implement a React component that displays a list of items"
+
+# Run with a prompt from a file
+mycoder -f prompt.txt
+
+# Enable GitHub mode
+mycoder config set githubMode true
+```
+
 ## Packages
 
 - [mycoder](packages/cli) - Command-line interface for MyCoder

packages/cli/README.md

@@ -1,6 +1,6 @@
 # MyCoder CLI
 
-Command-line interface for AI-powered coding tasks.
+Command-line interface for AI-powered coding tasks. Full details available on the main [MyCoder.ai website](https://mycoder.ai) and the [Official MyCoder.Ai Docs website](https://docs.mycoder.ai).
 
 ## Features
 
@@ -18,6 +18,8 @@ Command-line interface for AI-powered coding tasks.
 npm install -g mycoder
 ```
 
+For detailed installation instructions for macOS and Linux, including how to set up Node.js using NVM, [see our Getting Started guide](https://docs.mycoder.ai/docs/getting-started/).
+
 ## Usage
 
 ```bash

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

@@ -107,9 +107,11 @@ export const command: CommandModule<SharedOptions, DefaultArgs> = {
 
       if (providerSettings) {
         const { keyName } = providerSettings;
-        
+
         // First check if the API key is in the config
-        const configApiKey = userConfig[keyName as keyof typeof userConfig] as string;
+        const configApiKey = userConfig[
+          keyName as keyof typeof userConfig
+        ] as string;
         // Then fall back to environment variable
         const envApiKey = process.env[keyName];
         // Use config key if available, otherwise use env key
@@ -119,7 +121,7 @@ export const command: CommandModule<SharedOptions, DefaultArgs> = {
           logger.error(getProviderApiKeyError(userModelProvider));
           throw new Error(`${userModelProvider} API key not found`);
         }
-        
+
         // If we're using a key from config, set it as an environment variable
         // This ensures it's available to the provider libraries
         if (configApiKey && !envApiKey) {

packages/cli/src/commands/config.ts

@@ -1,5 +1,6 @@
-import chalk from 'chalk';
 import { createInterface } from 'readline/promises';
+
+import chalk from 'chalk';
 import { Logger } from 'mycoder-agent';
 
 import { SharedOptions } from '../options.js';
@@ -159,20 +160,20 @@ export const command: CommandModule<SharedOptions, ConfigOptions> = {
       if (argv.key.includes('API_KEY')) {
         logger.warn(
           chalk.yellow(
-            'Warning: Storing API keys in configuration is less secure than using environment variables.'
-          )
+            'Warning: Storing API keys in configuration is less secure than using environment variables.',
+          ),
         );
         logger.warn(
           chalk.yellow(
-            'Your API key will be stored in plaintext in the configuration file.'
-          )
+            'Your API key will be stored in plaintext in the configuration file.',
+          ),
         );
-        
+
         // Ask for confirmation
         const isConfirmed = await confirm(
-          'Do you want to continue storing your API key in the configuration?'
+          'Do you want to continue storing your API key in the configuration?',
         );
-        
+
         if (!isConfirmed) {
           logger.info('Operation cancelled.');
           return;
@@ -216,22 +217,26 @@ export const command: CommandModule<SharedOptions, ConfigOptions> = {
       if (argv.all) {
         // Confirm with the user before clearing all settings
         const isConfirmed = await confirm(
-          'Are you sure you want to clear all configuration settings? This action cannot be undone.'
+          'Are you sure you want to clear all configuration settings? This action cannot be undone.',
         );
-        
+
         if (!isConfirmed) {
           logger.info('Operation cancelled.');
           return;
         }
-        
+
         // Clear all settings
         clearAllConfig();
-        logger.info('All configuration settings have been cleared. Default values will be used.');
+        logger.info(
+          'All configuration settings have been cleared. Default values will be used.',
+        );
         return;
       }
-      
+
       if (!argv.key) {
-        logger.error('Key is required for clear command (or use --all to clear all settings)');
+        logger.error(
+          'Key is required for clear command (or use --all to clear all settings)',
+        );
         return;
       }
 

packages/cli/tests/settings/config.test.ts

@@ -127,4 +127,4 @@ describe('Config', () => {
       expect(result).toEqual({ githubMode: true, existingSetting: 'value' });
     });
   });
-});
+});