Skip to content

Commit 9aabded

Browse files
Remove the codename from our docs (#304)
1 parent 645b37d commit 9aabded

File tree

7 files changed

+18
-19
lines changed

7 files changed

+18
-19
lines changed

README.md

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# AI Shell (a.k.a Project Mercury)
1+
# AI Shell
22

33
Welcome to the **AI Shell** repository! AI Shell is a CLI tool that brings the power of artificial
44
intelligence directly to your command line! Designed to help you get command assistance from various
@@ -7,10 +7,9 @@ We call these various AI assistant providers _agents_. You can use agents to int
77
generative AI models or other AI/ML/assistant providers in a conversational manner. This repo
88
contains the code of the AI Shell engine, agents and details on how to create your own agent.
99

10-
Why the name **Project Mercury**? This was the original code name of the project and was inspired
11-
both by the Roman god of messages and the first human spaceflight by the US. This project is our
12-
first step into the new world of AI powered assistance and focuses on being the connection (or
13-
messenger) between the user and the AI model.
10+
You may have seen this project previously as **Project Mercury**. This was the code name that was
11+
used before we created the AI Shell brand. We are now in the process of transitioning to the new
12+
brand. The code name may still be used in some places, but the product name is now AI Shell.
1413

1514
This project is currently in a very early **public preview** state. Expect many significant changes
1615
to the code as we experiment and refine the user experiences of this tool. We appreciate your
@@ -51,7 +50,7 @@ Some prerequisites for building an AI Shell:
5150

5251
Here are the steps to install and use.
5352

54-
1. Clone this repository, `git clone https://github.com/PowerShell/ProjectMercury`
53+
1. Clone this repository, `git clone https://github.com/PowerShell/AIShell`
5554
2. Import the `build.psm1` module by running `import-module ./build.psm1`
5655
3. Run the `Start-Build` command (You can specify which agents build with the `-AgentsToInclude`
5756
parameter)
@@ -61,7 +60,7 @@ Here are the steps to install and use.
6160

6261
## AI Agents
6362

64-
Project Mercury provides a framework for creating and registering multiple AI Agents. The agents are
63+
AI Shell provides a framework for creating and registering multiple AI Agents. The agents are
6564
libraries that you use to interact with different AI models or assistance providers. AI Shell
6665
releases with two agents, the `openai-gpt` and `azure` agent. However there are additional ones
6766
supported if you locally build the project:

docs/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
1-
# Contributing to Project Mercury
1+
# Contributing to AI Shell
22

3-
Thank you for your interest in contributing to Project Mercury! We aren't currently accepting pull
3+
Thank you for your interest in contributing to AI Shell! We aren't currently accepting pull
44
requests, but we highly value your contributions in other forms.
55

66
## Reporting Issues
77

88
Issues are a great way to contribute to the project. By creating a detailed report, you help us
99
understand and prioritize what needs attention. Whether it's a bug or a feature request, your
10-
reports play a crucial role in improving Project Mercury.
10+
reports play a crucial role in improving AI Shell.
1111

1212
### How to Report an Issue
1313

docs/FAQ.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Frequently Asked Questions
22

3-
This page provides help with common questions about Project Mercury.
3+
This page provides help with common questions about AIS hell.
44

5-
## What is Project Mercury?
5+
## What is AI Shell?
66

7-
**Project Mercury** is a platform that provides a framework for developers to build their own AI
7+
**AI Shell** is a platform that provides a framework for developers to build their own AI
88
Agents and assistance providers for an AI Shell. Agents provide the user experience for the LLM and are
99
deeply connected to PowerShell 7. For more about the architecture, see the
1010
[shell/README][01].
@@ -27,7 +27,7 @@ model or AI engine.
2727

2828
## What operating systems are supported?
2929

30-
We have tested on macOS and Windows operating systems. **Project Mercury** may work on linux but we
30+
We have tested on macOS and Windows operating systems. **AI Shell** may work on linux but we
3131
haven't tested it can't guarantee that all features will work as expected.
3232

3333
## How do I get a split pane experience in my Terminal?

docs/SUPPORT.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ For other help and questions please see:
2121
[01]: ../README.md
2222
[02]: ../shell/README.md
2323
[03]: ./FAQ.md
24-
[04]: https://github.com/PowerShell/ProjectMercury/issues
25-
[05]: https://github.com/PowerShell/ProjectMercury/issues/new/choose
24+
[04]: https://github.com/PowerShell/AIShell/issues
25+
[05]: https://github.com/PowerShell/AIShell/issues/new/choose
2626
[07]: ../shell/agents/AIShell.Interpreter.Agent/README.md
2727
[08]: ../shell/agents/AIShell.OpenAI.Agent/README.md

docs/development/CreatingAnAgent.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -512,4 +512,4 @@ loaded by `aish`.
512512
[03]: ../../shell/README.md
513513
[04]: https://github.com/ollama/ollama
514514
[05]: https://github.com/ollama/ollama/blob/main/docs/api.md#request-no-streaming
515-
[06]: https://github.com/PowerShell/ProjectMercury/discussions/categories/agent-sharing
515+
[06]: https://github.com/PowerShell/AIShell/discussions/categories/agent-sharing

shell/AIShell.Integration/AIShell.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,5 +13,5 @@
1313
VariablesToExport = '*'
1414
AliasesToExport = @('aish', 'askai', 'fixit')
1515
HelpInfoURI = 'https://aka.ms/aishell-help'
16-
PrivateData = @{ PSData = @{ Prerelease = 'preview1'; ProjectUri = 'https://github.com/PowerShell/ProjectMercury' } }
16+
PrivateData = @{ PSData = @{ Prerelease = 'preview1'; ProjectUri = 'https://github.com/PowerShell/AIShell' } }
1717
}

tools/packaging/packaging.strings.psd1

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
<id>AIShell.Abstraction</id>
77
<version>{0}</version>
88
<authors>Microsoft</authors>
9-
<projectUrl>https://github.com/PowerShell/ProjectMercury</projectUrl>
9+
<projectUrl>https://github.com/PowerShell/AIShell</projectUrl>
1010
<requireLicenseAcceptance>false</requireLicenseAcceptance>
1111
<license type="expression">MIT</license>
1212
<licenseUrl>https://licenses.nuget.org/MIT</licenseUrl>

0 commit comments

Comments
 (0)