Shellmate is a Mac Terminal companion that gives you dynamic error correction and guidance seamlessly (keeping you in your Terminal and in the flow).

Features

Ask questions: Ask ShellMate with natural text about your Terminal context.

Detect & Fix errors: ShellMate uses your terminal history to detect & fix errors and predict which commands you’ll need next.

Highlight text: Highlight text to call ShellMate's "attention" to a particular issue.

Never switch focus: You’ll never need to leave your Terminal. Use the sm shortcut to ask questions and insert AI-generated suggestions straight into your active console. Example: sm “find a file?”

Demo

Installation Instructions

From DMG

Download here: https://www.deepspring.ai/shellmate

From source

git clone [email protected]:srosro/deepspring-shellmate.git

To run from source, open and build the repository in Xcode.

OpenAI API Key Setup

This app includes a free-tier usage feature, but the API key has been deleted. To use it, you'll need to update the hardcoded variable with your own API key at line 16 in the Utils.swift file located at ShellMate/Helpers/Utils.swift in the repository.

func getHardcodedOpenAIAPIKey() -> String {
    return "your-openai-api-key-here"
}

Alternatively, you can add your OpenAI API key directly in the settings or permissions view, which allows the key to be used without hardcoding it.

Setting Up Secrets and Sentry Authentication Token for ShellMate

1. Setting Up the Secrets.xcconfig File

In this project, we use configuration settings files to manage sensitive information, like the Sentry authentication token. You'll need to create a Secrets.xcconfig file in the project.

You should see an existing file named Template.Secrets.xcconfig and possibly a Secrets.xcconfig file. If the Secrets.xcconfig file appears red in Xcode, it's because Xcode expects the file, but it hasn’t been created yet.

To create the Secrets.xcconfig file:

Option 1: Create the File Using Xcode

1. Right-click on the ShellMate project (root of the project navigator).
2. Select New File.
3. Scroll down to the Other section and choose the Configuration Settings File option.
4. Create a new file called Secrets. (The .xcconfig extension will be added automatically.)

Option 2: Create the File Manually

1. Navigate to the root folder of the project in your terminal or file explorer.
2. Copy the existing Template.Secrets.xcconfig file and rename the copy to Secrets.xcconfig.

This new Secrets.xcconfig file will allow you to add your Sentry authentication token securely.

2. Creating a Sentry Authentication Token

To integrate Sentry into ShellMate, you’ll need to create an authentication token for Sentry:

1. Follow this tutorial to create your Sentry authentication token: Create a Sentry Authentication Token.
2. Once you've created the token, add it to the Secrets.xcconfig file like this:

SENTRY_AUTH_TOKEN=<your_token_here>

Replace <your_token_here> with the actual token value from Sentry.

Setting Up Developer Certificate

Creating a Certificate Signing Request (CSR)

1. Open Keychain Access on your Mac (Applications > Utilities > Keychain Access)
2. From the menu bar, choose Keychain Access > Certificate Assistant > Request a Certificate From a Certificate Authority
3. In the Certificate Assistant dialog:
   • Enter your Apple Developer email address in the "User Email Address" field
   • Enter your name in the "Common Name" field
   • Leave the "CA Email Address" field empty
   • Select "Saved to disk" option
   • Click "Continue"
4. Choose a location to save the .certSigningRequest file
5. Send this file to your Apple Developer team admin to sign the certificate

For Team Admins: Signing the Developer ID Certificate

1. Go to Apple Developer Portal
2. Click the "+" button to add a new certificate
3. Under "Software", select "Developer ID Application" (this is required for distributing outside the App Store)
4. Click "Continue"
5. Upload the .certSigningRequest file received from the developer
6. Click "Continue" to generate the certificate
7. Download the generated .cer file and send it back to the developer
8. The developer should double-click the .cer file to install it in their Keychain

Contributing

ShellMate is an open-source project and we welcome contributions from the community.

If you'd like to contribute, please fork the repository and make changes as you'd like. Pull requests are warmly welcome.

Our contributors

License

This project is licensed under the MIT License - see the LICENSE file for details.