From 1a4ea2688c232c5d28ddbe1d4fabf1431b8ac469 Mon Sep 17 00:00:00 2001 From: mentatai <162378962+mentatai@users.noreply.github.com> Date: Tue, 7 Jan 2025 21:53:44 +0000 Subject: [PATCH 1/3] Update README to indicate archived status This commit updates the README to clearly indicate that this is an archived project and prevents confusion with the current Mentat GitHub bot. Key changes: - Added prominent archive notice at the top - Added explanation about the current Mentat GitHub bot - Removed outdated badges and contribution information - Kept historical documentation for reference - Added project status section Closes #590 --- README.md | 35 ++++++++++++++--------------------- 1 file changed, 14 insertions(+), 21 deletions(-) diff --git a/README.md b/README.md index fb905fc68..31f7bc878 100644 --- a/README.md +++ b/README.md @@ -1,20 +1,20 @@ -[![Twitter Follow](https://img.shields.io/twitter/follow/AbanteAi?style=social)](https://twitter.com/AbanteAi) -[![Discord Follow](https://dcbadge.vercel.app/api/server/XbPdxAMJte?style=flat)](https://discord.gg/zbvd9qx9Pb) -[![Documentation Status](https://readthedocs.org/projects/mentat-ai/badge/?version=latest)](https://docs.mentat.ai/en/latest/?badge=latest) -[![Stable Version](https://img.shields.io/pypi/v/mentat?color=blue)](https://pypi.org/project/mentat/) -[![License](https://img.shields.io/pypi/l/mentat.svg)](https://github.com/AbanteAI/mentat/blob/main/LICENSE) +# ⚠ī¸ ARCHIVED PROJECT ⚠ī¸ -# 🧙‍♂ī¸ Mentat ⚡ +This repository contains an archived version of Mentat, which was an AI-powered command line tool for coding assistance. This project is no longer maintained or supported. -> _It is by will alone I set my mind in motion_ -> -> The Mentat Mantra +## Important Note About the Current Mentat -The Mentats of Dune combine human creativity with computer-like processing - and now you can too. +The name "Mentat" is now used by a different project - a GitHub bot that helps with code reviews and issue resolution. If you're looking for the current Mentat GitHub bot, this is not the correct repository. The Mentat bot is a proprietary service by AbanteAI and is not open source. --- -Mentat is the AI tool that assists you with any coding task, right from your command line. +# Historical Information: Mentat CLI Tool + +This was a command-line tool that assisted with coding tasks using AI. Below is the historical documentation kept for reference: + +> _It is by will alone I set my mind in motion_ +> +> The Mentat Mantra Unlike Copilot, Mentat coordinates edits across multiple locations and files. And unlike ChatGPT, Mentat already has the context of your project - no copy and pasting required! @@ -85,15 +85,8 @@ For more information on commands, configuration or using other models see [the d Mentat uses [Textual](https://textual.textualize.io/). On MacOS, Textual may not render the TUI correctly; if you run into this problem, use the fix [here](https://textual.textualize.io/FAQ/#why-doesnt-textual-look-good-on-macos). -# 👩‍đŸ’ģ Roadmap and Contributing - -We welcome contributions! To coordinate, make sure to join the Discord server: [![Discord Follow](https://dcbadge.vercel.app/api/server/XbPdxAMJte?style=flat)](https://discord.gg/zbvd9qx9Pb) - -The goal for Mentat is to become the best way to write code. Some big improvements coming up are: - -- seamlessly work with codebases much larger than LLM context limits, without requiring users to filter files manually -- improved edit quality +# ℹī¸ Project Status -If this is something you'd like to work on, jump right in! And if you want to join the team to work on this full time, message [@bio_bootloader](https://twitter.com/bio_bootloader) on twitter. +This project has been archived and is no longer maintained. The development team has moved on to other projects, including the current Mentat GitHub bot. We recommend looking for alternative active projects if you need a command-line AI coding assistant. -To find something specific to work on, take a look at [open issues](https://github.com/AbanteAI/mentat/issues). +If you're interested in AbanteAI's current work, you can follow them on Twitter: [@AbanteAI](https://twitter.com/AbanteAi). From 332a05fcbb11fe90fcb6064727106dcc7c4eab86 Mon Sep 17 00:00:00 2001 From: mentatai <162378962+mentatai@users.noreply.github.com> Date: Tue, 7 Jan 2025 21:58:08 +0000 Subject: [PATCH 2/3] Simplify README to just archive notice and mentat.ai link Removed all historical content and documentation as requested, keeping only: - Archive notice - Link to mentat.ai for the current Mentat service - Link to AbanteAI Twitter --- README.md | 91 +++---------------------------------------------------- 1 file changed, 5 insertions(+), 86 deletions(-) diff --git a/README.md b/README.md index 31f7bc878..a0a11bb5d 100644 --- a/README.md +++ b/README.md @@ -1,92 +1,11 @@ # ⚠ī¸ ARCHIVED PROJECT ⚠ī¸ -This repository contains an archived version of Mentat, which was an AI-powered command line tool for coding assistance. This project is no longer maintained or supported. +This repository contains an archived version of an old command-line tool that is no longer maintained or supported. -## Important Note About the Current Mentat +## Looking for Mentat? -The name "Mentat" is now used by a different project - a GitHub bot that helps with code reviews and issue resolution. If you're looking for the current Mentat GitHub bot, this is not the correct repository. The Mentat bot is a proprietary service by AbanteAI and is not open source. +The name "Mentat" is now used by a different project - an AI-powered GitHub bot that helps with code reviews and issue resolution. If you're interested in using Mentat, please visit: ---- +**[mentat.ai](https://mentat.ai)** -# Historical Information: Mentat CLI Tool - -This was a command-line tool that assisted with coding tasks using AI. Below is the historical documentation kept for reference: - -> _It is by will alone I set my mind in motion_ -> -> The Mentat Mantra - -Unlike Copilot, Mentat coordinates edits across multiple locations and files. And unlike ChatGPT, Mentat already has the context of your project - no copy and pasting required! - -Want help understanding a new codebase? Need to add a new feature? Refactor existing code? Mentat can do it! - -# đŸŋ Example Videos (🔊 on!) - -https://github.com/AbanteAI/mentat/assets/128252497/35b027a9-d639-452c-a53c-ef019a645719 - -See more videos on [Twitter](https://twitter.com/bio_bootloader/status/1683906735248125955) or YouTube: - -- [Intro (2 min - same video as above)](https://www.youtube.com/watch?v=lODjaWclwpY) -- [Explaining and editing Llama2.c (3 min)](https://www.youtube.com/watch?v=qSyTWMFOjPs) -- [More Mentat features (4 min)](https://www.youtube.com/watch?v=YJLDIqq8k2A) - -# ⚙ī¸ Setup - -[Installation and Setup Demonstration Video](https://www.youtube.com/watch?v=bVJP8hY8uRM) - -## Install - -It is recommended you install this package in a virtualenv: - -``` -# Python 3.10 or higher is required -python3 -m venv .venv -source .venv/bin/activate -``` - -Note that you'll have to have activated the virtual environment to run mentat if you install it there. - -There are then 3 install methods. The first two will just let you run it: - -- PyPI: `python -m pip install mentat` -- Github: `python -m pip install git+https://github.com/AbanteAI/mentat.git` - -The third option is useful if you'd also like to modify Mentat's code, as well as run it: - -``` -git clone https://github.com/AbanteAI/mentat.git -cd mentat - -# install with pip in editable mode: -pip install -e . -``` - -### Add your OpenAI API Key - -There are a few options to provide Mentat with your OpenAI API key: - -1. Create a `.env` file with the line `OPENAI_API_KEY=` in the directory you plan to run mentat in or in `~/.mentat/.env` -2. Run `export OPENAI_API_KEY=` prior to running Mentat -3. Place the previous command in your `.bashrc` or `.zshrc` to export your key on every terminal startup - -If you want to use a models through Azure, Ollama or other services see [this doc](https://docs.mentat.ai/en/latest/user/alternative_models.html) for details. - -# 🚀 Usage - -Run Mentat from within your project directory. Mentat uses git, so if your project doesn't already have git set up, run `git init`. Then you can run Mentat with: - -`mentat ` - -List the files you would like Mentat to read and edit as arguments. Mentat will add each of them to context, so be careful not to exceed the GPT-4 token context limit. To add multiple files at once, you can also provide directories as arguments. When a directory is provided, Mentat will add all the contained files, except for ones ignored in your `.gitignore`. In addition to files and directories, you can use [glob patterns](https://docs.python.org/3/library/glob.html) to add multiple files at once. - -For more information on commands, configuration or using other models see [the documentation](https://docs.mentat.ai/en/latest/user/guides.html). - -## MacOS Visual Artifacts - -Mentat uses [Textual](https://textual.textualize.io/). On MacOS, Textual may not render the TUI correctly; if you run into this problem, use the fix [here](https://textual.textualize.io/FAQ/#why-doesnt-textual-look-good-on-macos). - -# ℹī¸ Project Status - -This project has been archived and is no longer maintained. The development team has moved on to other projects, including the current Mentat GitHub bot. We recommend looking for alternative active projects if you need a command-line AI coding assistant. - -If you're interested in AbanteAI's current work, you can follow them on Twitter: [@AbanteAI](https://twitter.com/AbanteAi). +For any questions about the current Mentat service, you can follow [@AbanteAI](https://twitter.com/AbanteAi) on Twitter. From 3178e1011c109f09f68348098e02dc1eea645811 Mon Sep 17 00:00:00 2001 From: mentatai <162378962+mentatai@users.noreply.github.com> Date: Tue, 7 Jan 2025 22:02:10 +0000 Subject: [PATCH 3/3] Update description of current Mentat bot Changed the description to more accurately reflect that Mentat writes and reviews code, rather than just helping with reviews and issues. --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index a0a11bb5d..ed02ccacc 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,7 @@ This repository contains an archived version of an old command-line tool that is ## Looking for Mentat? -The name "Mentat" is now used by a different project - an AI-powered GitHub bot that helps with code reviews and issue resolution. If you're interested in using Mentat, please visit: +The name "Mentat" is now used by a different project - an AI-powered GitHub bot that writes and reviews code. If you're interested in using Mentat, please visit: **[mentat.ai](https://mentat.ai)**