README.md

Example Commands and Results

The following examples showcase how to use the github-echo tool. Each command demonstrates different options and outputs.

• Getting Help
  • Default Help Menu
  • Detailed Help Menu
  • Help for a Specific Command
• Version Information
  • Check the Version
• Configuration Management
  • Create a Configuration File
  • Remove the Configuration File
• Analyzing GitHub Repositories
  • Analyze a Repository
  • Output to a File
• Customizing Configurations
  • Modifying Defaults in the Config File
  • Disabling Token Usage Display
• Adjusting Parameters
  • Changing the Temperature
  • Selecting a Different Model
• Author

Getting Help

Default Help Menu

Running the following command displays the help menu:

gh-echo

Detailed Help Menu

To explicitly access the help menu, use:

gh-echo --help

Help for a Specific Command

To view the help menu for a specific command, such as analyze, use:

gh-echo analyze --help

---

Version Information

Check the Version

Use one of the following commands to see the current version of the tool:

gh-echo --version
# OR
gh-echo -v

---

Configuration Management

Create a Configuration File

To generate a default configuration file:

gh-echo init

The generated configuration file will look similar to this:

Remove the Configuration File

To delete the configuration file:

gh-echo remove-config

---

Analyzing GitHub Repositories

Analyze a Repository

To analyze a GitHub repository:

gh-echo analyze https://github.com/AryanK1511/github-echo

Output to a File

To redirect the analysis output to a file:

gh-echo analyze https://github.com/AryanK1511/github-echo -o output.md

The markdown output will look like this:

---

Customizing Configurations

Modifying Defaults in the Config File

Adjust the settings in the configuration file as needed. For example:

Disabling Token Usage Display

By modifying the configuration, you can disable token usage information in the output:

Alternatively, enable it using the --show-token-usage flag:

gh-echo analyze https://github.com/AryanK1511/github-echo --show-token-usage

---

Adjusting Parameters

Changing the Temperature

Modify the model temperature for the analysis using:

gh-echo analyze https://github.com/AryanK1511/github-echo -o output.md -t 1
# OR
gh-echo analyze https://github.com/AryanK1511/github-echo -o output.md --model-temperature 1

Selecting a Different Model

Specify a different model for analysis using:

gh-echo analyze https://github.com/AryanK1511/PiZone -o output.md -t 1 -m groq
# OR
gh-echo analyze https://github.com/AryanK1511/PiZone -o output.md -t 1 --model groq

Author

Aryan Khurana