Skip to content

Commit

Permalink
refactor(vscode): refactor status related commands. (#3520)
Browse files Browse the repository at this point in the history
* refactor(vscode): refactor status related commands.

* fix(vscode): fix typo in config description.

* fix(vscode): fix grammar for walkthrough guide.
  • Loading branch information
icycodes authored Dec 6, 2024
1 parent fc956e5 commit ff5a71d
Show file tree
Hide file tree
Showing 29 changed files with 821 additions and 943 deletions.
10 changes: 3 additions & 7 deletions clients/vscode/assets/walkthroughs/codeCompletion.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,12 +6,8 @@ Tabby suggests multi-line code completions and full functions in real-time as yo

![Autocomplete Demo](https://tabby.tabbyml.com/img/demo.gif)

### Multiple Choice
### Multiple Choices

To access more suggestion choices, hover over a suggestion, or press `Alt + [` or `Alt + ]` to cycle through the suggestions. There may be a slight delay as the alternative choices are generated upon your request.
To access more suggestion choices, hover over a suggestion or press `Alt + [` or `Alt + ]` to cycle through the suggestions. There may be a slight delay as the alternative choices are generated upon your request.

![Multiple Choice Demo](./multipleChoice.png)

## Manual Trigger Mode

If you prefer to use Tabby code completion in a more manual way. You can select the manual trigger mode in the [Settings](command:tabby.openSettings). This mode allows you to trigger code completion by pressing `Alt + \`.
![Multiple Choices Demo](./multipleChoice.png)
3 changes: 3 additions & 0 deletions clients/vscode/assets/walkthroughs/commandPalette.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 5 additions & 3 deletions clients/vscode/assets/walkthroughs/commands.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,9 @@
# Tabby Commands
# Commands

Search for Tabby commands by typing `Tabby` in the command palette.
You can click on the `Tabby` status bar item to open the [Tabby Command Palette](command:tabby.commandPalette.trigger) and select the desired command.

![Commands](./commands.png)
![Tabby Command Palette](./commandPalette.png)

You can also search for `Tabby` in the [command palette](command:workbench.action.quickOpen?%5B%22%3ETabby%22%5D) to see a list of all available commands provided by the Tabby extension.

**Note**: Commands related to chat features are only visible when your server supports them.
3 changes: 0 additions & 3 deletions clients/vscode/assets/walkthroughs/commands.png

This file was deleted.

16 changes: 9 additions & 7 deletions clients/vscode/assets/walkthroughs/connectToServer.md
Original file line number Diff line number Diff line change
@@ -1,17 +1,19 @@
# Connect to Server

**Tips**: If you are using local deployment and default port `http://localhost:8080`, you can simply skip this step.
To connect to the Tabby server, follow these steps:

Open the command palette (`Ctrl+Shift+P` or `Cmd+Shift+P`) and search for the command [Tabby: Connect to Server...](command:tabby.setApiEndpoint). Follow the instructions to input the Tabby server's endpoint URL and the token.
1. Click the Tabby status bar item to open the commands panel and select [Connect to Server...](command:tabby.connectToServer).

![connectToServer](./connectToServer.png)
2. Follow the instructions to input the Tabby server's endpoint URL:
![connectToServer_url](./connectToServer_url.png)

Once the connection is established, you will see the Tabby status bar item showing checkmark.
3. Enter the token:
![connectToServer_token](./connectToServer_token.png)

![statusbarReady](./statusbarReady.png)
Once the connection is established, the Tabby status bar item will show a checkmark:

Alternatively, you can set the endpoint in the [Settings](command:tabby.openSettings).
![statusbarReady](./statusbarReady.png)

## Cross-IDE Settings

If you are using multiple IDEs, you can use the [Config File](command:tabby.openTabbyAgentSettings) to share the settings across IDEs. Refer to the [Online Documentation](https://tabby.tabbyml.com/docs/extensions/configurations/) for more details.
If you are using multiple IDEs, you can use the [Tabby Agent Config File](command:tabby.openTabbyAgentSettings) to share the settings across IDEs. Refer to the [Online Documentation](https://tabby.tabbyml.com/docs/extensions/configurations/) for more details.
3 changes: 0 additions & 3 deletions clients/vscode/assets/walkthroughs/connectToServer.png

This file was deleted.

3 changes: 3 additions & 0 deletions clients/vscode/assets/walkthroughs/connectToServer_token.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
3 changes: 3 additions & 0 deletions clients/vscode/assets/walkthroughs/connectToServer_url.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions clients/vscode/assets/walkthroughs/statusbarReady.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
24 changes: 7 additions & 17 deletions clients/vscode/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -45,15 +45,10 @@
"category": "Tabby"
},
{
"command": "tabby.setApiEndpoint",
"command": "tabby.connectToServer",
"title": "Connect to Server...",
"category": "Tabby"
},
{
"command": "tabby.setApiToken",
"title": "Set Token...",
"category": "Tabby"
},
{
"command": "tabby.openSettings",
"title": "Open Settings",
Expand All @@ -75,8 +70,8 @@
"category": "Tabby"
},
{
"command": "tabby.notifications.resetMuted",
"title": "Reset notifications marked as \"Don't Show Again\"",
"command": "tabby.status.resetIgnoredIssues",
"title": "Reset Ignored Issues",
"category": "Tabby"
},
{
Expand Down Expand Up @@ -135,11 +130,6 @@
"title": "Discard Changes",
"category": "Tabby"
},
{
"command": "tabby.server.selectPastServerConfig",
"title": "Select Server Endpoint from History",
"category": "Tabby"
},
{
"command": "tabby.chat.createPanel",
"title": "Open Chat in Editor",
Expand Down Expand Up @@ -248,7 +238,7 @@
{
"id": "connectToServer",
"title": "Connect to Server",
"description": "Connect the Tabby extension to your server. \n[Connect to Server](command:tabby.setApiEndpoint)",
"description": "Connect the Tabby extension to your server. \n[Connect to Server](command:tabby.connectToServer)",
"media": {
"markdown": "assets/walkthroughs/connectToServer.md"
}
Expand All @@ -272,7 +262,7 @@
{
"id": "commands",
"title": "Commands",
"description": "Explore all Tabby commands. \n[Tabby commands](command:workbench.action.quickOpen?%5B%22%3ETabby%22%5D)",
"description": "Explore all [Tabby Commands](command:workbench.action.quickOpen?%5B%22%3ETabby%22%5D). \n[Tabby Command Palette](command:tabby.commandPalette.trigger)",
"media": {
"markdown": "assets/walkthroughs/commands.md"
}
Expand All @@ -296,8 +286,8 @@
"type": "string",
"default": "",
"pattern": "(^$)|(^https?:\\/\\/\\S+$)",
"patternErrorMessage": "Please enter a validate http or https URL.",
"markdownDescription": "Specify the API endpoint for the Tabby server. \nIf authentication is required, please [Set Credentials](command:tabby.setApiToken). \nIf left empty, the server endpoint specified in the [Tabby Agent Settings](command:tabby.openTabbyAgentSettings) will be used."
"patternErrorMessage": "Please enter a valid HTTP or HTTPS URL.",
"markdownDescription": "Please use the command [Connect to Server](command:tabby.connectToServer) to specify the endpoint of the Tabby server."
},
"tabby.keybindings": {
"type": "string",
Expand Down
136 changes: 0 additions & 136 deletions clients/vscode/src/CommandPalette.ts

This file was deleted.

Loading

0 comments on commit ff5a71d

Please sign in to comment.