root
/
tabby
mirror of https://gitee.com/zhang_1334717033/tabby.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs(clients): update getting-started and troubleshooting docs. (#531)

r0.3
Zhiming Ma 2023-10-11 12:11:54 +08:00 committed by GitHub
parent fceb8c9217
commit 5be9a6ae1b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 63 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
clients/intellij/README.md
View File

@ -1,12 +1,30 @@
# Tabby Plugin for IntelliJ Platform
[![JetBrains plugins](https://img.shields.io/jetbrains/plugin/d/22379-tabby)](https://plugins.jetbrains.com/plugin/22379-tabby)
## Requirements
- Tabby plugin works with all IntelliJ Platform IDEs that have build 2022.2.5 or later versions, such as Idea, PyCharm, Android Studio, and more.
- Tabby plugin requires [Node.js](https://nodejs.org) 18.0+ to be installed and added into the `PATH` environment variable.
Tabby is an AI coding assistant that can suggest multi-line code or full functions in real-time.
## Installation
You can install Tabby plugin from the IntelliJ Platform [plugin marketplace](https://plugins.jetbrains.com/plugin/22379-tabby).
Tabby IntelliJ Platform plugin works with all [IntelliJ Platform IDEs](https://plugins.jetbrains.com/docs/intellij/intellij-platform.html#ides-based-on-the-intellij-platform) that have build 2022.2.5 or later versions, such as [IDEA](https://www.jetbrains.com/idea/), [PyCharm](https://www.jetbrains.com/pycharm/), [GoLand](https://www.jetbrains.com/go/), [Android Studio](https://developer.android.com/studio), and [more](https://plugins.jetbrains.com/docs/intellij/intellij-platform.html#ides-based-on-the-intellij-platform).
## Getting Started
1. Set up the Tabby Server: you can build your self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation/), or get a Tabby Cloud hosted server [here](https://app.tabbyml.com).
**Note**: Tabby Cloud is currently in **closed** beta. Join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and ask in Tabby Cloud channel to get a beta invite.
2. Install Tabby plugin from [JetBrains Marketplace](https://plugins.jetbrains.com/plugin/22379-tabby).
3. Install [Node.js](https://nodejs.org/en/download/) version 18.0 or higher.
4. Open the settings by clicking on the Tabby plugin status bar item and select `Open Settings...`.
1. Fill in the server endpoint URL to connect the plugin to your Tabby server.
* If you are using default port `http://localhost:8080`, you can skip this step.
* If you are using a Tabby Cloud server endpoint, follow the instructions provided in the popup messages to complete the authorization process.
2. Fill in node binary path if the node binary.
* If node binary is already accessible via your `PATH` environment variable, you can skip this step.
* Remember to save the settings and restart the IDE if you made changes to this option.
5. Check the Tabby plugin status bar item, it should display a check mark if the plugin is successfully connected to the Tabby server.
## Troubleshooting
If you encounter any problem, please check out our [troubleshooting guide](https://tabby.tabbyml.com/docs/extensions/troubleshooting).
## Development and Build
To develop and build Tabby plugin, please clone this directory and open it with IntelliJ Idea.
To develop and build Tabby plugin, please clone [this directory](https://github.com/TabbyML/tabby/tree/main/clients/intellij) and import it into IntelliJ Idea.

3
clients/vscode/README.md
View File

@ -22,7 +22,8 @@ Try our online demo [here](https://tabby.tabbyml.com/playground).
Once you have installed the Tabby VSCode extension, you can easily get started by following the built-in walkthrough guides. You can access the walkthrough page at any time by using the command `Tabby: Getting Started`.
1. **Setup the Tabby server**: You have two options to set up your Tabby server. You can either get a Tabby Cloud hosted server [here](https://app.tabbyml.com) or build your own self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation).
1. **Setup the Tabby server**: You have two options to set up your Tabby server. You can either build your own self-hosted Tabby server following [this guide](https://tabby.tabbyml.com/docs/installation) or get a Tabby Cloud hosted server [here](https://app.tabbyml.com).
**Note**: Tabby Cloud is currently in **closed** beta. Join our [Slack community](https://join.slack.com/t/tabbycommunity/shared_invite/zt-1xeiddizp-bciR2RtFTaJ37RBxr8VxpA) and ask in #help-self-hosting channel to get a beta invite.
2. **Connect the extension to your Tabby server**: Use the command `Tabby: Specify API Endpoint of Tabby` to connect the extension to your Tabby server. If you are using a Tabby Cloud server endpoint, follow the instructions provided in the popup messages to complete the authorization process.
Once the setup is complete, Tabby will automatically provide inline suggestions. You can accept the suggestions by simply pressing the `Tab` key.

43
website/docs/extensions/troubleshooting.md
View File

@ -7,6 +7,35 @@ sidebar_position: 99
This document aims to assist you in troubleshooting issues with the Tabby extensions
for various IDEs such as VSCode, IntelliJ Platform IDEs, and Vim / NeoVim.
## Tabby Initialization Failed?
This problem may occur when you first install the Tabby in IntelliJ Platform IDEs
or Vim/NeoVim.
The Tabby IDE extension runs its core logic in the Tabby agent. In the case of VSCode,
the agent runs within the VSCode Extension Host, while for IntelliJ Platform IDEs
and Vim/NeoVim, the agent runs as a separate Node.js process.
### Install Node.js
You can follow the instructions on the [Node.js website](https://nodejs.org/en/download/)
to install Node.js. Alternatively, you can use a version manager such as [nvm](https://github.com/nvm-sh/nvm).
**Note**: Tabby IDE extension requires Node.js version 18.0.0 or higher.
### Specify Node Binary Path
If the node binary is already accessible via your `PATH` environment variable,
you can skip this step. Otherwise, you will need to specify the path to the node
binary in the IDE settings.
For IntelliJ Platform IDEs (Tabby plugin version 0.6.0 or higher):
* Click on Tabby plugin status bar item and select `Open Settings...`.
* Enter the path to the node binary on your system in the `Node binary` field,
e.g. `/usr/local/bin/node`, `C:\Program Files\nodejs\node.exe`.
If you are using a version manager such as `nvm`, you can enter the path to the
node binary installed by the version manager, e.g. `~/.nvm/versions/node/v18.18.0/bin/node`.
* Restart the IDE
## Cannot Connect to Tabby Server?
If you have setup the endpoint for the Tabby server but the status bar item of
@ -90,12 +119,10 @@ You can adjust this timeout value in the `~/.tabby-client/agent/config.toml` con
## Want to Deep Dive via Logs?
If you cannot solve issue the issue using the previous steps, you may want to
If you cannot solve the issue using the previous steps, you may want to
investigate further by checking the debug logs.
The Tabby IDE extension runs its core logic in the Tabby agent. In the case of VSCode,
the agent runs within the VSCode Extension Host, while for IntelliJ Platform IDEs
and Vim/NeoVim, the agent runs as a separate Node.js process.
### Tabby Agent Debug Logs
To enable Tabby agent debug logs, editing `~/.tabby-client/agent/config.toml` file,
uncomment the `logs` section and set `level` to `"debug"`. Save the file to apply the changes.
@ -109,8 +136,12 @@ use `pino-pretty` to format the log file for easier readability.
tail -f ~/.tabby-client/agent/logs/tabby-agent.log | npx pino-pretty
```
For IntelliJ Platform IDEs, you can check the logs for the UI using `Help -> Open Log in Editor`.
This log file contains all the logs for the IDE, and you can filter them by searching for the keyword `tabby`.
### IntelliJ Platform IDEs Logs
For IntelliJ Platform IDEs, you can check the logs for the IDE using `Help -> Open Log in Editor`,
or follow [this document](https://intellij-support.jetbrains.com/hc/en-us/articles/206544519-Directories-used-by-the-IDE-to-store-settings-caches-plugins-and-logs) to locate the log file.
This log file contains all the logs for the IDE, and you can filter them by searching for the
keyword `com.tabbyml.intellijtabby`.
## Still Have Issues?