Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wasertech/codepilot

Your AI command line copilot.
https://github.com/wasertech/codepilot

copilot github-copilot gpt-4 shell-aliases shell-functions

Last synced: about 2 months ago
JSON representation

Your AI command line copilot.

Host: GitHub
URL: https://github.com/wasertech/codepilot
Owner: wasertech
License: gpl-3.0
Created: 2023-12-17T22:58:02.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2024-07-15T20:40:25.000Z (5 months ago)
Last Synced: 2024-10-08T21:04:10.926Z (3 months ago)
Topics: copilot, github-copilot, gpt-4, shell-aliases, shell-functions
Language: Shell
Homepage:
Size: 148 KB
Stars: 2
Watchers: 1
Forks: 0
Open Issues: 2
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Awesome Lists containing this project

README

Copilot

CodePilot

Your AI command line copilot.

> I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

You need an active subscription to [GitHub Copilot](https://github.com/settings/copilot) to use this tool.

## Table of Content

- [Table of Content](#table-of-content)
- [Introduction](#introduction)
- [Explain](#explain)
- [Explanation:](#explanation)
- [How do I?](#how-do-i)
- [Explanation:](#explanation-1)
- [Use the Shell to ...](#use-the-shell-to-)
- [Suggestion:](#suggestion)
- [Use Docker to ...](#use-docker-to-)
- [Suggestion:](#suggestion-1)
- [Suggestion:](#suggestion-2)
- [Help](#help)
- [Explanation:](#explanation-2)
- [Explanation:](#explanation-3)
- [Explanation:](#explanation-4)
- [Too long; didn't read (the manual)](#too-long-didnt-read-the-manual)
- [Explanation:](#explanation-5)
- [What is ... ?](#what-is--)
- [Explanation:](#explanation-6)
- [Pre-requisites](#pre-requisites)
- [Installation](#installation)
- [Usage](#usage)
- [Commands](#commands)
- [Welcome](#welcome)
- [Help](#help-1)
- [Explain](#explain-1)
- [Suggest](#suggest)
- [Use Git (command)](#use-git-command)
- [Use GitHub CLI](#use-github-cli)
- [Use the Shell](#use-the-shell)
- [Use Docker](#use-docker)
- [Use Python](#use-python)
- [How do I ... ?](#how-do-i--)
- [Too long; didn't read (the manual page)](#too-long-didnt-read-the-manual-page)
- [Can you please ... ?](#can-you-please--)
- [`copilot` `==` `codepilot`](#copilot--codepilot)
- [Updating CodePilot](#updating-codepilot)
- [Contributing](#contributing)
- [License](#license)

## Introduction

CodePilot is a collection of shell scripts that wraps the [GitHub Copilot CLI](https://github.com/github/gh-copilot) into a more user-friendly interface through the use of various aliases and functions.

Such as:

---

### Explain

You can ask GitHub Copilot to explain something, like navigating the shell.

```shell
❯ explain "how to navigate dirs"
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

To navigate directories, you can use the following commands:

- `cd` is used to change directory.
- `cd` foldername changes the current directory to foldername.
- `cd` `..` moves up one directory level.
- `cd` `~` moves to the home directory.
- `cd` `/` moves to the root directory.
- `cd` `-` switches to the previous directory.
- `pwd` displays the current working directory.
- `ls` lists files and directories in the current directory.
- `ls -l` provides a detailed listing.
- `ls -a` shows hidden files and directories.
- `ls -h` displays file sizes in human-readable format.
- `ls -t` sorts files by modification time.
- `ls` -r reverses the order of the listing.

---

You can also ask in various ways.

### How do I?

```shell
❯ howdoi "navigate dirs"
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

To navigate directories in a shell:

- `cd` is used to change the current directory.
- `cd ` changes the current directory to the specified directory.
- `cd ..` moves one level up to the parent directory.
- `cd ~` moves to the home directory.
- `pwd` prints the current working directory.
- `ls` lists the files and directories in the current directory.
- `ls ` lists the files and directories in the specified directory.
- `-l` provides a long listing format.
- `-a` includes hidden files and directories in the listing.
- `-t` sorts the listing by modification time.
- `-r` reverses the order of the listing.
- `-h` uses human-readable file sizes in the listing.
- `mkdir` creates a new directory.
- `mkdir ` creates a directory with the specified name.

---

### Use the Shell to ...

```shell
❯ use_sh_to "navigate dirs"
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Suggestion:

```shell
cd /path/to/directory
```

_? Select an option_
> Exit

---

Based on `use_sh_to`, you can also also ask for help with Docker.

### Use Docker to ...

Like with previous `use_*_to` commands, you can converse with GitHub Copilot to sugesst the most adequate command. This time, for Docker.

```shell
❯ use_docker_to "navigate dirs"
```

Welcome to GitHub Copilot in the CLI!
version 0.5.3-beta (2023-11-09)

I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

Suggestion not readily available. Please revise for better results.

? _What would you like the shell command to do?_
> load a volume and navigate to in in the container using bash as my entrypoint

#### Suggestion:

```shell
docker run -v /path/to/volume:/container/path -it image_name bash
```

? _Select an option_
> Revise command

? _How should this be revised?_
> How would I navigate to /container/path once in the container?

#### Suggestion:

```shell
cd /container/path
```

? _Select an option_
> Exit

---

Notice **some commands are designed to accept only certain arguments**, such as (but not limited to) command names.

### Help

```shell
❯ help "navigate dirs"
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

To get more information about the behavior of a program in the command line, you can use the following commands:

1. `man `: This command displays the manual pages for a specific program, providing detailed information about its usage, options, and
behavior.
- The `` should be replaced with the name of the program you want to learn more about.
2. ` --help`: Many programs provide a built-in help option that displays a summary of the command-line options and their descriptions.
- Replace `` with the name of the program you want to learn more about.
3. Online search: You can also search for the program`s documentation or user guides online to find more detailed information about its behavior
and usage.

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

Explanation not readily available. Please revise for better results.

---

Help is designed to accept the name of one or more commands.

```shell
❯ help --help
```

(Meta)**Help**

_Get help about a command._

_Usage_: `help `

_Example_: `help nano`

_Example_: `help --help`

_Example_: `help`

---

So in in this case the correct way to ask for help would be:

```shell
❯ help "cd"
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

To get more information about the behavior of the cd command as a program in the command line, you can use the man command which displays the
manual page for a given command. To get the manual page for cd, you can run man cd.

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

- cd is used to change the current working directory.
- Usage: cd `[directory]`
- `[directory]` is an optional parameter specifying the directory you want to change to.
- If no `[directory]` is provided, cd changes to the user`s home directory.
- You can use relative or absolute paths as the `[directory]` parameter.
- You can use special characters like `.` (current directory) and `..` (parent directory) in the path.
- Examples:
- `cd /path/to/directory`: Changes to the directory `/path/to/directory`.
- `cd ~`: Changes to the user`s home directory.
- `cd ..`: Changes to the parent directory.
- `cd`: Changes to the user`s home directory.

---

Much more helpful but sometimes it can be a bit too much helpful. Who finds the time to read the docs? Let's get a TL;DR version.

### Too long; didn't read (the manual)

Give me the gist of how to use the `cd` command.

```shell
❯ tldr 'cd'
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:

- cd is used to change the current working directory.
- The basic usage of cd is simply cd , where is the name of the directory you want to navigate to.
- Here are some examples of cd usages:
- cd /path/to/directory navigates to the absolute path /path/to/directory.
- cd .. navigates to the parent directory of the current directory.
- cd ~ navigates to the home directory of the current user.
- cd - navigates to the previous working directory.
- cd / navigates to the root directory.
- cd without any arguments navigates to the home directory.

---

### What is ... ?

```shell
❯ whatis "cd"
```

**Welcome to GitHub Copilot in the CLI!**
version 0.5.3-beta (2023-11-09)

I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.

Explanation:

- cd is a command used to change the current working directory

---

You don't have to remember all these commands. You can ask GitHub Copilot to remind you by asking for help.

```shell
❯ help
```

**Welcome to GitHub Copilot in the CLI!**
> version 0.5.3-beta (2023-11-09)

_I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve._

#### Explanation:
To get help in the shell, you can use the following commands:

- `man` `[command]`: Displays the manual page for a specific command.
- `help` `[built-in command]`: Provides information about built-in shell commands.
- `[command] --help`: Displays help information for a specific command.
- `info` `[command]`: Shows documentation for a command using the GNU info system.
- `apropos` `[keyword]`: Searches the manual page descriptions for a given keyword.
- `tldr` `[command]`: Provides simplified and community-driven usage examples for command-line tools.
- `whatis` `[command]`: Displays a brief summary of a command.

Some useful commands:

- Get help for a particular command

```shell
help
```

- How do I ... ?

```shell
howdoi ''
```

- Too long; didn't read (the manual).

Give me the gist of how to use this command:

```shell
tldr ''
```

- What is ... ?

```shell
whatis ''
```

- Use git to ...

```shell
use_git_to ''
```

- Use GitHub CLI to ...

```shell
use_gh_to ''
```

- Use the shell to ...

```shell
use_sh_to ''
```

- Use Docker to ...

```shell
use_docker_to ''
```

- Use Python to ...

```shell
use_py_to ''
```

- Explain ...

```shell
explain ''
```

- Suggest Command Interactively

```shell
suggest
```

- Suggest [Git, GitHub, Shell] Command to ...

```shell
suggest -t [git|gh|shell] ''
```

## Pre-requisites

The following are required to use CodePilot:

- A Shell: [Bash](https://www.gnu.org/software/bash/) or [Zsh](https://www.zsh.org/)
- [Git](https://git-scm.com/)
- [GitHub CLI](https://cli.github.com/)

They must be installed and configured before you can use CodePilot. An active [GitHub Copilot](https://copilot.github.com/) subscription is also required.

## Installation

Copy and paste the following command in your terminal.

```shell
wget -O install https://raw.githubusercontent.com/wasertech/CodePilot/main/install > /dev/null 2>&1 && chmod +x install && ./install
```

Then hit enter and follow the instructions.

## Usage

### Commands

Some typical commands you can use with CodePilot are:

#### Welcome

```shell
❯ welcome
```

> Welcome to GitHub Copilot in the CLI!
> version 0.5.3-beta (2023-11-09)
>
> I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve.
>
> Explanation:
>
> To operate the shell:
>
> - Use commands to perform specific tasks or operations.
> - Use command options or flags to modify the behavior of commands.
> - Combine commands using pipes (|) to pass the output of one command as the input to another.
> - Use redirection operators (`>`, `>>`, `<`) to redirect input and output.
>
> - Use command substitution (`$(...)` or `...`) to capture the output of a command and use it as part of another command.
> - Use variables to store and manipulate data.
> - Use loops (for, while) to iterate over lists or execute commands repeatedly.
> - Use conditionals (if, case) to control the flow of execution based on conditions.
> - Use control operators (&&, ||, ;) to combine multiple commands and control their execution.
> - Use file and directory manipulation commands (`ls`, cp, mv, rm, mkdir, `cd`) to work with files and directories.
> - Use text processing commands (grep, sed, awk) to search for patterns and manipulate text.
> - Use package management commands (apt-get, yum, brew) to manage software packages.
> - Use version control system commands (git, svn) to manage source code repositories.
> - Use system monitoring commands (ps, top, htop) to monitor system processes.
> - Use network-related commands (ping, curl, ssh) to interact with network resources.
> - Use help commands (man, info, --help) to get information about commands and their usage.
> - Use the shell`s built-in features (history, command line editing, tab completion) to enhance productivity.
>
> Note: The shell and its usage may vary depending on the operating system and shell you are using.

#### Help

```shell
❯ help
```

#### Explain

Explain a command or a concept.

```shell
❯ explain 'what is a dbus session bus'
```

#### Suggest

Suggest a command to run.

```shell
❯ suggest -t shell "split csv using awk"
```

#### Use Git (command)

Get help with Git.

```shell
❯ use_git_to 'Undo the most recent local commits'
```

#### Use GitHub CLI

Get help with GitHub CLI.

```shell
❯ use_gh_to 'Create pull request'
```

#### Use the Shell

Get help with the shell.

```shell
❯ use_sh_to 'Kill processes holding onto deleted files'
```

#### Use Docker

Get help with Docker.

```shell
❯ use_docker_to 'list images'
```

#### Use Python

Get help with Python.

```shell
❯ use_py_to 'list files in a directory'
```

#### How do I ... ?

Ask GitHub Copilot how to do something.

```shell
❯ howdoi 'print hello world'
```

#### Too long; didn't read (the manual page)

Give me the gist of how to use this command.

```shell
❯ tldr 'git commit'
```

#### Can you please ... ?

Can you please suggest a command to execute?

```shell
❯ can_you_please show me my running processes
I can certainly try. Who knows maybe you'll like my solution, if so please simply copy the command I'll suggest and I'll take care of the rest.

Welcome to GitHub Copilot in the CLI!
version 1.0.5 (2024-09-12)

I'm powered by AI, so surprises and mistakes are possible. Make sure to verify any generated code or suggestions, and share feedback so that we can learn and improve. For more information, see https://gh.io/gh-copilot-transparency

Suggestion:

ps aux

? Select an option
> Copy command to clipboard

Command copied to clipboard!
Would you like me to execute the suggested command?
waser: Yes please.
Executing the suggested command now...
USER PID %CPU %MEM VSZ RSS TTY STAT START TIME COMMAND
root 1 0.0 0.0 21288 11916 ? Ss oct19 0:01 /sbin/init splash
[...]
waser 95164 0.0 0.0 10532 6956 pts/9 R+ 00:40 0:00 ps aux
I hope this was useful. If you have any other questions, feel free to ask using the help command.
```

You can also use `can_you`, `could_you` and `could_you_please` interchangeably.

### `copilot` `==` `codepilot`

You can run CodePilot by using either `copilot` or `codepilot` commands interchangeably.

```shell
❯ which copilot
```

> copilot: aliased to gh copilot

```shell
❯ which codepilot
```

> codepilot: aliased to gh copilot

```shell
❯ codepilot --version
version 0.5.3-beta (2023-11-09)
❯ copilot --help
Your AI command line copilot.

Usage:
copilot `[command]`

Examples:

$ gh copilot suggest "Install git"
$ gh copilot explain "traceroute github.com"

Available Commands:
config Configure options
explain Explain a command
suggest Suggest a command

Flags:
-h, --help help for copilot
-v, --version version for copilot

Use "copilot `[command]` --help" for more information about a command.
```

## Updating CodePilot

When Copilot tells you there's a new version available, you can update GitHub Copilot CLI by running the following command:

```shell
❯ gh_copilot_install
[copilot]:
upgraded from v0.5.3-beta to v0.5.4-beta
✓ Successfully upgraded extension
```

Copilot will prompt you for a version number. You can either enter the version number you want to install or leave it blank to install the latest version. Then hit enter to confirm.

If you want to update the shell scripts, you can run the following command:

```shell
codepilot_update
```

## Contributing

Built with the help of [GitHub Copilot](https://copilot.github.com/). Inspired by [Howdoi](https://github.com/gleitz/howdoi), [tldr](https://github.com/tldr-pages/tldr) and [what-is-cli](https://github.com/zeke/what-is-cli).

If like this project, please consider:
1. Starring the [Project](https://github.com/wasertech/CodePilot)
2. Sharing it with your friends and colleagues
3. Becoming a [sponsor](https://github.com/sponsors/wasertech) ❤️
4. Helping GitHub foot the bill for [Copilot](https://github.com/features/copilot) by subscribing to it
5. Submmiting new ways to wrap the GitHub Copilot CLI into a more user-friendly interface through the use of various aliases and functions

## License

[GNU General Public License Version 3](LICENSE)