Skip to content

Commit 86075ca

Browse files
armgitaarashokgelalEineeshGelal
authored
Dev (#136)
* docs for vibe cli proxy * docs for ai powered icon suggestion * docs for branch explorer * updated docs for disabling shiftcuts feature * updated docs for copy to clipboard standards * updated docs for gguf and safetensors support * docs for moving a child project to root * information about the vibe CLI proxy service * docs for enabling and disabling spellcheck feature * Refactor Vibe CLI Proxy documentation Updated section headers and improved clarity in instructions. * edits * edits --------- Co-authored-by: Ashok Gelal <ashokgelal@gmail.com> Co-authored-by: Eineesh Gelal <eineeshgelal@gmail.com>
1 parent 2f97979 commit 86075ca

7 files changed

Lines changed: 177 additions & 5 deletions

File tree

content/1.getting-started/5.managing-models.md

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -63,15 +63,16 @@ The **Installed Models** tab displays the models currently installed on your dev
6363

6464
The **Ollama Models** and **Hugging Face Models** tabs allow you to search Ollama and Hugging Face for models that you can install onto your device. As long as the model is public and has an available GGUF (GPT-Generated Unified Format) file for download, then it typically is available to install.
6565

66-
::alert{type="info" icon="tabler:info-circle"}
67-
Msty does not support Safetensors nor split GGUFs.
68-
::
66+
The **Import GGUF Model** tab allows you to Select a GGUF model file from your file system to import into Msty Local AI.
6967

7068
## Import a GGUF Model
71-
To import a GGUF model that you have downloaded locally, select **Import GGUF** and then browse to the location of the GGUF file on your device.
69+
To import a GGUF model that you have downloaded locally, navigate to the **Import GGUF** tab, select directory and then browse to the location of the GGUF file on your device.
7270

7371
You can either establish a symlink to point Msty Studio to the GGUF file location, or you can copy the GGUF file into Msty Studio's models directory.
7472

73+
## Import a Safetensors Model
74+
To import a Safetensors Model that you have downloaded locally, navigate to the **Import Safetensors** tab, select directory and then browse to the location of the Safetensors file on your device.
75+
7576
## Model Squad
7677

7778
Model Squad is a collection of specialized AI models to assist with Msty functionality.

content/2.features/19.keyboard-shortcuts.md

Lines changed: 31 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,28 @@ You can access the keyboard shortcuts settings in **Settings > Keyboard Shortcut
1515

1616
![keyboard shortcuts](/images/shortcuts/keyboard-shortcuts.png)
1717

18-
Some actions have a default shortcut assigned, which you can use that shortcut or customize to your liking.
18+
Some actions have a default shortcut assigned, which you can use that shortcut or customize to your liking.
1919

20+
## Spell Check Toggle (Desktop)
21+
22+
For Desktop users, Msty Studio provides an option to disable the built-in spell check feature. This is particularly useful for developers writing code or for users whose language isn't supported well by the spell checker. When disabled, the red underlines for unrecognized words will no longer appear.
23+
24+
### How to Toggle Spell Check
25+
26+
::steps
27+
### Open General Settings
28+
Go to **Settings > General**.
29+
30+
### Find Spell Check Option
31+
Scroll down to locate the spell check toggle.
32+
33+
### Change and Restart
34+
Switch the spell check setting as desired, then **restart the application** for the changes to take full effect.
35+
::
36+
37+
::alert{type="info" icon="tabler:info-circle"}
38+
Studio Web can disable via the browser settings. For Studio Desktop, please note your OS settings may override this option.
39+
::
2040

2141
## How to Use Shiftcuts
2242

@@ -46,4 +66,14 @@ This will toggle the visibility of the sidebar, allowing you to maximize your wo
4666
This will open a picker that allows you to quickly select an [environment variable](/features/environments). This is useful for inserting variables into your conversations or for quickly accessing specific information.
4767
![shiftcut env picker](/images/shiftcuts/shiftcut-env.png)
4868

69+
## How to Disable ShiftCuts
70+
71+
::steps
72+
### Open Keyboard Shortcuts Settings
73+
Navigate to **Settings > Keyboard Shortcuts**.
74+
75+
### Toggle the Feature Off
76+
At the top of the keyboard shortcuts page, you'll find a switch to enable or disable the Shift Cut feature. Turn it off to deactivate the shortcut completely.
77+
::
78+
4979
::Resources

content/2.features/21.settings.md

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,22 @@ MLX is availble for Apple Silicon devices only.
7373
* Enable Network Access - allow other devices on local network to connect
7474
* Capture Service Logs - enable local AI services logging
7575

76+
## Vibe CLI Proxy
77+
78+
Vibe CLI Proxy allows Msty Studio to connect to various CLI providers through a secure local proxy.
79+
80+
* Service Health - displays current status with options to stop, start and restart
81+
* Service Endpoint - endpoint if you'd like to connect other applications to the vibe CLI proxy
82+
* Service Version - displays current version with options to check for updates and remove service
83+
* Service Configurations
84+
* Enable Network Access - allow other devices on the network to reach the proxy
85+
* Capture Service Logs - persist proxy logs for troubleshooting (may increase disk usage)
86+
* Port - the local port where the proxy service listens for requests
87+
* Retries - number of retry attempts for failed upstream requests
88+
* Auth Folder - path where Vibe CLI Proxy stores OAuth tokens for connected providers. Managed automatically; not editable
89+
* Authentication - securely link your AI accounts so Vibe CLI Proxy can call their APIs on your behalf. When you connect, a browser window opens for that provider where you complete sign-in, setup, and authorize [Vibe CLI Proxy providers](/features/vibe-cli-proxy)
90+
91+
7692

7793
## Remote Service
7894

Lines changed: 47 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,47 @@
1+
---
2+
title: Vibe CLI Proxy
3+
description: Connect command-line model providers to use their AI models
4+
navTruncate: false
5+
resources:
6+
videos:
7+
blogs:
8+
---
9+
10+
Integrate models from supported CLI applications directly into Msty Studio. This integration supports multiple CLI providers and makes their models available for conversations.
11+
12+
### Supported CLI Providers
13+
14+
- Claude Code
15+
- Codex
16+
- Google Gemini
17+
- iFlow
18+
- Github Copilot
19+
- Antigravity
20+
21+
## Link CLI Provider
22+
23+
::steps
24+
### Open CLI Settings
25+
Go to **Settings > Vibe CLI Proxy**.
26+
27+
### Authorize
28+
Under Authentication, select your provider and click **Authorize**.
29+
30+
### Complete Flow
31+
When you connect, a browser window opens for the selected provider, allowing you to complete the authorization and sign-in process.
32+
33+
::
34+
35+
## Use CLI Models
36+
37+
::steps
38+
### Select Model
39+
In any conversation, open the model selector.
40+
41+
### Choose Provider
42+
Models from authorized CLI providers will appear in the list. Select one to begin chatting.
43+
::
44+
45+
::alert{type="info" icon="tabler:info-circle"}
46+
CLI models work alongside your other configured models, no extra setup needed after authorization. Enabled CLI providers will also appear in the Model Hub.
47+
::
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Branch Explorer
3+
description: Navigate and compare branches easily
4+
navTruncate: false
5+
resources:
6+
videos:
7+
blogs:
8+
---
9+
10+
Threads and the mini map include a branch dropdown for better navigation and comparison. The Branch Explorer allows you to label branches and perform side-by-side diff comparisons between different conversation branches.
11+
12+
## Using Branch Explorer in Threads
13+
14+
::steps
15+
### Access Branch Dropdown
16+
In any thread, locate the new branch dropdown menu(Edit as Branch). When you use the feature for a user or assistant message and update the prompt a new branch is created that contains the updated user and assistant message
17+
18+
### Label or Explore
19+
Use the dropdown to **label a branch** or open **Branch Explorer**.
20+
21+
### Compare Branches
22+
Branch Explorer displays a side-by-side diff view, letting you compare content between two selected branches.
23+
::
24+
25+
## Using Branch Explorer in Mini Map
26+
27+
::steps
28+
### Open Mini Map
29+
Access the mini map interface.
30+
31+
### Select Branch
32+
Use the branch dropdown to select a different branch.
33+
34+
### View Updates
35+
The mini map will update to reflect the selected branch, allowing for quick navigation and comparison.
36+
::
37+
38+
::Resources

content/2.features/5.conversations/1.responses.md

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,27 @@ Manage your conversation responses with easy-to-use chat management tools that h
1212

1313
Copy the response to your clipboard for easy sharing and pasting.
1414

15+
#### How to Copy Text to the clipboard
16+
17+
::steps
18+
### Long Press Copy Button
19+
In any conversation, long-press the copy button on a message.
20+
21+
### Select Format
22+
Choose and copy the desired copy method from the options.
23+
24+
### Paste into desired location
25+
The copied text is now in your clipboard and can be pasted into text editors.
26+
27+
### Set Default Behavior
28+
Msty Studio remembers your last selected copy method (Markdown, HTML, or Formatted Text) and uses it as the default the next time you click the copy button.
29+
::
30+
31+
#### Supported Copy Methods
32+
- Markdown
33+
- HTML
34+
- Formatted Text
35+
1536
### Bookmark message
1637

1738
Bookmark the message for easy access later. Bookmarked messages are saved in the **Bookmarks** section located at the top of the window.

content/2.features/5.conversations/3.organize.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,25 @@ Toggle the filter icon to display the search field and sort and display button.
6767
- Empty folders
6868
- Number of conversations within a folder
6969

70+
## Promote Child Project to Root Level
71+
72+
If you need to move a child project (and all its conversations and subfolders) to the root level of your workspace, you can do so easily.
73+
74+
::steps
75+
### Select the Folder
76+
Click on the folder you want to move.
77+
78+
### Open Folder Options
79+
Click the ellipses icon (⋯) next to the folder.
80+
81+
### Move to Root
82+
Select **Move folder to root** from the menu. The folder and all its children will be moved to the root level of your project structure.
83+
::
84+
85+
::alert{type="info" icon="tabler:info-circle"}
86+
This action preserves the folder's entire subtree structure when moving it to root.
87+
::
88+
7089
## Archive Old Conversations
7190

7291
In **Settings > General > Conversations**, you can auto and manually archive conversations older than the number of days you define.

0 commit comments

Comments
 (0)