https://github.com/nrjdalal/ai-x-terminal
AI X Terminal is a powerful command-line tool that enhances your terminal capabilities using OpenAI's API. Integrate AI seamlessly into your workflow with functionalities to append file contents or entire workspace details to queries, facilitating an enriched coding and development experience.
https://github.com/nrjdalal/ai-x-terminal
ai automation chatgpt cli code-analysis coding-assistant command-line developer-tools file-analysis openai productivity terminal workflow workspace-analysis
Last synced: 5 months ago
JSON representation
AI X Terminal is a powerful command-line tool that enhances your terminal capabilities using OpenAI's API. Integrate AI seamlessly into your workflow with functionalities to append file contents or entire workspace details to queries, facilitating an enriched coding and development experience.
- Host: GitHub
- URL: https://github.com/nrjdalal/ai-x-terminal
- Owner: nrjdalal
- Created: 2024-11-20T00:04:39.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-05T20:30:28.000Z (over 1 year ago)
- Last Synced: 2025-04-15T05:18:29.741Z (about 1 year ago)
- Topics: ai, automation, chatgpt, cli, code-analysis, coding-assistant, command-line, developer-tools, file-analysis, openai, productivity, terminal, workflow, workspace-analysis
- Language: TypeScript
- Homepage:
- Size: 58.6 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# AI X Terminal
> Links: [GitHub Repo](https://github.com/nrjdalal/ai-x-terminal) / [npm Package](https://www.npmjs.com/package/ai-x-terminal)
**AI X Terminal** is a powerful command-line tool that integrates OpenAI's API to enhance your terminal experience with AI capabilities. It supports appending file contents or entire workspaces to requests, thus allowing a seamless integration with your existing projects.
## Demo
[](https://asciinema.org/a/US2lyqiL6vNzDxH681x6LFnLN)
## Installation
To install AI X Terminal globally, you can use either npm or bun:
```bash
npm install -g ai-x-terminal
```
OR
```bash
bun add -g ai-x-terminal
```
## Features
- **Command Line Arguments**: Use the tool with various options to customize its behavior.
- `-f, --file `: Append specified file content to the AI prompt.
- `-w, --workspace`: Append contents of all files in the current directory to the prompt.
- `-ls, --list`: List all filenames in the current directory.
- `-p, --persona `: Customize the AI's persona for responses.
- **OpenAI Integration**: Initialize with your OpenAI API key for future use without re-entering.
- **Code Syntax Highlighting**: Automatically detects code snippets and formats them for better readability.
## Usage Examples
### Basic Usage
```bash
ax "What is the meaning of life?"
```
### Using a File
```bash
ax -f example.txt "Summarize this file."
```
### Using the Current Workspace
```bash
ax -w "Provide an overview of this project."
```
### Listing Files
```bash
ax -ls "Which of these files are safe to delete?"
```
### Customizing AI Persona
```bash
ax -p "You are a coding expert" "Explain this code snippet."
```
---
## Configuration
AI X Terminal uses a `.ax.json` configuration file to store settings like the persona. Modify this file to personalize your interactions.
## Contributing
Contributions are welcome! If you have suggestions, feature requests, or bug reports, please create an issue or submit a pull request. Adhere to the code style used in the project and ensure your changes do not break any existing functionality.
## License
This project is licensed under the MIT License. See the [LICENSE](https://github.com/nrjdalal/ai-x-terminal/blob/main/LICENSE) file for details.
## Disclaimer
Keep your OpenAI API key confidential. Never share it publicly.
## Upcoming Features
- Multi-API support
- Contextual AI enhancements
For more features and updates, refer to our [changelog](https://github.com/nrjdalal/ai-x-terminal/releases).
```
### Key Additions:
1. **Configuration Section**: Explains how to use `.ax.json`.
2. **Contributing**: Invites user contributions and sets expectations.
3. **Installation Details**: More clarity on installation via npm and bun.
4. **Usage Examples**: Improved with a new example of persona customization.
5. **Disclaimer note**: To remind users about API key security.
This will give prospective users a comprehensive overview and understanding of how to use and contribute to your project.
```