### Witsy Setup and Build
Source: https://github.com/nbonamy/witsy/blob/main/README.md
Instructions for setting up and building the Witsy project. This involves installing Node.js dependencies and starting the application.
```bash
npm install
npm start
```
--------------------------------
### macOS Installation
Source: https://github.com/nbonamy/witsy/blob/main/README.md
Instructions for installing Witsy on macOS using Homebrew.
```bash
brew install --cask witsy
```
--------------------------------
### Witsy Error Log Example
Source: https://github.com/nbonamy/witsy/wiki/MCP-Server-not-starting-on-macOS-and-Linux
This snippet shows a typical error message found in the Witsy main log file when the MCP server fails to connect due to a missing executable, indicated by 'ENOENT'. It highlights the importance of the PATH environment variable.
```log
[2025-04-27 09:25:16.440] [error] Failed to connect to MCP server bunx index.js: Error: spawn bunx ENOENT
at ChildProcess._handle.onexit (node:internal/child_process:286:19)
at onErrorNT (node:internal/child_process:484:16)
at processTicksAndRejections (node:internal/process/task_queues:82:21)
at runNextTicks (node:internal/process/task_queues:64:3)
at listOnTimeout (node:internal/timers:545:9)
at process.processTimers (node:internal/timers:519:7)
```
--------------------------------
### Formal JSON Schema Example
Source: https://github.com/nbonamy/witsy/wiki/Agents-JSON-format
Provides an example of a formal JSON schema for agent responses, including data types, constraints like minLength, maxLength, minimum, maximum, patterns, array item validation, and required properties. Witsy supports basic schema features but not extended attributes.
```json
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"type": "object",
"properties": {
"name": {
"type": "string",
"minLength": 2,
"maxLength": 50
},
"age": {
"type": "integer",
"minimum": 0,
"maximum": 120
},
"email": {
"type": "string",
"pattern": "^[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\\.[a-zA-Z]{2,}$"
},
"tags": {
"type": "array",
"items": {
"type": "string"
},
"uniqueItems": true,
"minItems": 1,
"maxItems": 10,
"contains": {
"enum": [
"user",
"admin",
"guest"
]
}
},
"coordinates": {
"type": "array",
"prefixItems": [
{
"type": "number",
"minimum": -90,
"maximum": 90
},
{
"type": "number",
"minimum": -180,
"maximum": 180
}
],
"items": false
},
"score": {
"type": "number",
"multipleOf": 0.5,
"minimum": 0,
"maximum": 100
}
},
"required": [
"name",
"email"
],
"additionalProperties": false,
"minProperties": 2,
"maxProperties": 10
}
```
--------------------------------
### Witsy Model Interaction Payloads
Source: https://github.com/nbonamy/witsy/wiki/Models-and-Plugins-aka-Tools-aka-Function-calling
This section describes the typical payloads exchanged between Witsy and an AI model when plugins are enabled. It highlights the two distinct requests made to the model during tool execution: the initial prompt and the subsequent request including tool results.
```APIDOC
WitsyModelInteraction:
Description: Payloads exchanged between Witsy and the AI model when plugins are enabled.
Process:
1. Initial Prompt Request:
- Sent with the original user prompt.
- Model responds with 'tool_call' instructions if a tool is to be used.
2. Tool Execution Result Request:
- Sent after a tool has been executed.
- Includes the result of the tool execution.
- Model uses this result to generate a final response.
Debugging:
- Access the Debug Console via the link in the Model Settings panel.
- Inspect the 'Request Body' to view the payloads.
ExamplePayloads:
- May include multiple tool definitions depending on enabled plugins.
```
--------------------------------
### Applying the Apache License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This section provides instructions on how to apply the Apache License to your project. It includes a boilerplate notice that needs to be customized with your project's specific information.
```APIDOC
Copyright {yyyy} {name of copyright owner}
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
```
--------------------------------
### Checking Executable Path
Source: https://github.com/nbonamy/witsy/wiki/MCP-Server-not-starting-on-macOS-and-Linux
This command demonstrates how to verify if an executable, such as 'bunx', is accessible through the system's PATH environment variable. The output should show the full path to the executable.
```sh
$ which bunx
/opt/homebrew/bin/bunx
```
--------------------------------
### @electron-forge/maker-squirrel Information
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
Information about the @electron-forge/maker-squirrel package, which is part of the Electron Forge build toolchain. It is used for creating Squirrel installers for Electron applications, primarily for Windows.
```plaintext
Project
@electron-forge/maker-squirrel
Source
https://github.com/electron/forge
License
The MIT License (MIT)
Copyright (c) 2016 Samuel Attard
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### Combat Resolution Prompt
Source: https://github.com/nbonamy/witsy/wiki/Creating-your-first-agents
This prompt defines the first step of the workflow, resolving a combat between two fighters. It uses templated variables for fighter names with default values.
```Witsy
Resolve the combat between {{fighter1:Name of 1st fighter:Luke}} and {{fighter2:Name of 2nd fighter:Vader}}.
```
--------------------------------
### API Key Prerequisites
Source: https://github.com/nbonamy/witsy/blob/main/README.md
Lists the necessary API keys required for various AI services used by Witsy, including OpenAI, Anthropic, Google, Mistral AI, DeepSeek, OpenRouter, Groq, Cerebras, Fal.ai, Fireworks.ai, Speechmatics, Gladia, and Tavily.
```APIDOC
OpenAI API Key: https://platform.openai.com/api-keys
Anthropic API Key: https://console.anthropic.com/settings/keys
Google API Key: https://aistudio.google.com/app/apikey
xAI API Key: https://console.x.ai/team/
Meta API Keys: https://llama.developer.meta.com/api-keys/
MistralAI API Keys: https://console.mistral.ai/api-keys/
DeepSeek API Keys: https://platform.deepseek.com/api_keys
OpenRouter API Keys: https://openrouter.ai/settings/keys
Groq API Keys: https://console.groq.com/keys
Cerebras API Keys: https://cloud.cerebras.ai/platform/
Ollama Installation: https://ollama.com
Ollama Models: https://ollama.com/search
Fal.ai API Key: https://fal.ai/dashboard/keys
Fireworks.ai API Key: https://app.fireworks.ai/settings/users/api-keys
Speechmatics API Key: https://portal.speechmatics.com/settings/api-keys
Gladia API Key: https://app.gladia.io/account
Tavily API Key: https://app.tavily.com/home
```
--------------------------------
### Tale Writing Prompt
Source: https://github.com/nbonamy/witsy/wiki/Creating-your-first-agents
This prompt defines the second step of the workflow, writing a tale based on the outcome of the first step. It uses an output variable `{{output.1}}` to incorporate the result of the combat resolution.
```Witsy
Fight outcome: {{output.1}}.
Based on this write the tale of the winner of the fight
```
--------------------------------
### Witsy Models and Plugins Documentation
Source: https://github.com/nbonamy/witsy/wiki/Ollama-Models-and-Plugins-aka-Tools
This entry links to the Witsy GitHub wiki for detailed information on models, plugins, and function calling. It serves as a central reference point for understanding these core components of the Witsy project.
```APIDOC
Project: /nbonamy/witsy
Content:
Please refer to https://github.com/nbonamy/witsy/wiki/Models-and-Plugins-aka-Tools-aka-Function-calling.
```
--------------------------------
### User Interface and Experience
Source: https://github.com/nbonamy/witsy/blob/main/README.md
Highlights enhancements to the user interface and overall user experience, including onboarding, customization options, chat management, and visual elements.
```APIDOC
Onboarding:
- Onboarding experience
Prompts/Experts:
- Add, Edit & Delete System Prompts
- Prompts renamed to Experts. Now editable.
- Custom prompts
Backup and Restore:
- Backup/Restore of data and settings
User Interface:
- Quick access buttons on home
- Debug console
- Design Studio
- i18n
- Mermaid diagram rendering
- Local Web Search
- Chat themes
- CSS variables
- Chat font size settings
- Dark mode
- Application Menu
- Status/Tray bar icon + global shortcut to invoke
- Keep running in system tray
- Nicer icon (still temporary)
- Save/Restore window position
- Copy code button
- Chat list ordering
Conversation Management:
- ChatGPT history import
- Fork chat (with optional LLM switch)
- Realtime chat
- Conversation mode
- Conversation language settings
- Conversation menu (info, save...)
- Conversation depth setting
- Rename conversation
- Copy/edit messages
- History date sections
- Prompt history navigation
- Multiple selection delete
- Search
Plugins and Integrations:
- Brave Search plugin
- Long-term memory plugin
- YouTube plugin
- Download internet content plugin
- Tavily Internet search plugin
- Python code execution plugin
Other Features:
- Multiple attachments
- DeepResearch
- Token usage report
- Image resize option
- Auto-update refactor (still not Windows)
- Auto-update
- Sandbox & contextIsolation
- Fix when long text is highlighted
- Auto-select expert based on foremost app (Mac only)
- Google function calling
- Scratchpad
- Ollama support
- View image full screen
- Default instructions in settings
- Latex rendering
- Image generation as b64_json
- Log file (electron-log)
- Paste image in prompt
- Run at login
- Shortcut editor
- Image attachment for vision
- Stop response streaming
```
--------------------------------
### Python Tool for Dice Rolling
Source: https://github.com/nbonamy/witsy/wiki/Creating-your-first-agents
Illustrates how to enable the `run_python_code` tool for an agent, which is necessary for executing Python scripts, such as generating random dice rolls.
```python
run_python_code
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This section provides the standard boilerplate text for applying the Apache License 2.0 to a project. It includes placeholders for copyright year and owner, and outlines the terms of use, distribution, and modification.
```plaintext
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Replicate Project License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet details the Apache License 2.0 for the Replicate project. It outlines the terms of use, distribution, and modification, emphasizing the 'as is' nature of the software and the limitations of liability.
```plaintext
Copyright 2023 Replicate, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
```
--------------------------------
### GNU GENERAL PUBLIC LICENSE Version 3
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This document outlines the terms and conditions of the GNU General Public License (GPL) Version 3. It covers the preamble, definitions, and the specific terms for copying, distribution, and modification of licensed works. The license aims to protect users' freedom to share and change software, ensuring it remains free.
```APIDOC
GNU GENERAL PUBLIC LICENSE
Version 3, 29 June 2007
Copyright (C) 2007 Free Software Foundation, Inc.
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.
Preamble:
The GNU General Public License is a free, copyleft license for
software and other kinds of works.
It guarantees users the freedom to share and change all versions of a program.
Terms and Conditions:
0. Definitions:
- "This License": Refers to version 3 of the GNU General Public License.
- "Copyright": Also means copyright-like laws that apply to other kinds of works.
- "The Program": Refers to any copyrightable work licensed under this License.
- "To modify": To copy from or adapt all or part of the work in a fashion requiring copyright permission, other than the making of an exact copy.
- "A covered work": Either the unmodified Program or a work based on the Program.
- "To propagate": To do anything with it that, without permission, would make you directly or secondarily liable for infringement under applicable copyright law, except executing it on a computer or modifying a private copy.
- "To convey": Any kind of propagation that enables other parties to make or receive copies.
```
--------------------------------
### MIT License (Takahiro Ethan Ikeuchi)
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This is the MIT License as applied by Takahiro Ethan Ikeuchi for the @iktakahiro/markdown-it-katex project. It is similar to the previous MIT license, granting extensive rights with the requirement to retain copyright and permission notices.
```plaintext
The MIT License (MIT)
Copyright (c) 2018 Takahiro Ethan Ikeuchi @iktakahiro
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate notice for applying the Apache License 2.0 to a project. It includes placeholders for copyright year and owner, and specifies the terms of use and distribution.
```plaintext
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate notice for applying the Apache License 2.0 to a project. It includes copyright information and the terms under which the software is distributed.
```text
Copyright 2024 Mistral AI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate notice for applying the Apache License, Version 2.0, to a project. It includes placeholders for identifying information and specifies the terms under which the software can be used.
```text
Copyright 2025 OpenAI
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### MIT License Template
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This is a standard MIT License template. It grants broad permissions for using, copying, modifying, merging, publishing, distributing, sublicensing, and/or selling copies of the software, with the condition that the copyright notice and permission notice are included in all copies or substantial portions of the Software.
```text
(The MIT License)
Copyright (c) 2010-2017 Nathan Rajlich
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate text for applying the Apache License, Version 2.0, to a project. It includes placeholders for copyright year and owner information and outlines the terms of use, modification, and distribution.
```plaintext
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate notice for applying the Apache License, Version 2.0, to a project. It includes placeholders for copyright year and owner, and specifies the terms of use and distribution.
```apache
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Apache License 2.0 Boilerplate
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet provides the standard boilerplate notice for applying the Apache License, Version 2.0, to a project. It includes placeholders for identifying information and specifies the terms of use and distribution.
```apache
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
--------------------------------
### Run-VBS MIT License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
Provides the full MIT License text for the run-vbs project, including copyright, permission grants, and disclaimers.
```License
MIT License
Copyright (c) 2021 Samuele de Tomasi
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### Electron Forge Maker-Dmg MIT License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
Presents the MIT License for the @electron-forge/maker-dmg package, outlining the terms for software usage, modification, and distribution.
```License
The MIT License (MIT)
Copyright (c) 2016 Samuel Attard
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### Verifying PATH in Witsy Logs
Source: https://github.com/nbonamy/witsy/wiki/MCP-Server-not-starting-on-macOS-and-Linux
These commands show how to extract and check the PATH variable as recorded by Witsy during its startup or operation. This helps determine if the directory containing the required executable is listed in the PATH Witsy is using.
```bash
macOS: grep 'Fixing PATH' ~/Library/Logs/Witsy/main.log | tail -1
Linux: grep 'Fixing PATH' ~/.config/Witsy/logs/main.log | tail -1
```
```bash
[2025-04-27 09:18:21.777] [info] Fixing PATH: ~/bin:/usr/local/sbin:/usr/local/bin:/System/Cryptexes/App/usr/bin:/usr/bin:/bin:/usr/sbin:/sbin:...
```
```bash
macOS: grep 'Fixing PATH' ~/Library/Logs/Witsy/main.log | tail -1 | grep /opt/homebrew/bin
Linux: grep 'Fixing PATH' ~/.config/Witsy/logs/main.log | tail -1 | grep /opt/homebrew/bin
```
--------------------------------
### markdown-it-mark License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This section outlines the license for the markdown-it-mark project. It grants broad permissions for use, modification, and distribution, provided the original copyright and permission notices are included. The software is provided without warranty.
```markdown
Copyright (c) 2014-2015 Vitaly Puzrin, Alex Kocharin.
Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:
The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### vitest License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
MIT License for the Vitest project. Allows broad usage and modification under specified conditions.
```text
MIT License
Copyright (c) 2021-Present Vitest Team
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### Dice Roller Agent Workflow Prompt
Source: https://github.com/nbonamy/witsy/wiki/Creating-your-first-agents
Specifies the prompt for a single-step workflow in the Dice Roller agent. It includes a variable `{{type:Type of dice to roll (D&D format)}}` which will prompt the user or a delegate agent for input.
```APIDOC
Give me a random number using {{type:Type of dice to roll (D&D format)}}
```
--------------------------------
### MIT License for ModelContextProtocol SDK
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet details the MIT License as applied to the @modelcontextprotocol/sdk project. It grants broad permissions for use, modification, and distribution, with the condition that the copyright and permission notice are included.
```text
Copyright (c) 2024 Anthropic, PBC
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### MIT License (Waylon Flinn)
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This is the MIT License as applied by Waylon Flinn for the @iktakahiro/markdown-it-katex project. It grants broad permissions for use, modification, and distribution, with the condition that the original copyright and permission notice are included.
```plaintext
The MIT License (MIT)
Copyright (c) 2016 Waylon Flinn
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### Powershell Project
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This entry refers to a project related to PowerShell, hosted on GitHub. No specific code snippet is provided, but the source repository is indicated.
```powershell
# Source: https://github.com/IonicaBizau/powershell
```
--------------------------------
### MIT License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet contains the standard MIT License text, including the copyright notice and permission statement. It grants broad rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell the software, with the condition that the license and copyright notice are included in all copies or substantial portions of the Software.
```mit
Copyright (c) [yyyy] [name of copyright owner]
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### AI Model Integrations
Source: https://github.com/nbonamy/witsy/blob/main/README.md
This section details the various AI models and APIs integrated into the Witsy project, enabling diverse functionalities such as text generation, image generation, speech processing, and more. It includes support for both cloud-based and local model deployments.
```APIDOC
OpenAI:
- GPT-5 support
- OpenAI API response (o3-pro)
- Custom OpenAI STT support
- OpenAI image generation
- Allow user-input models for embeddings
- Direct speech-to-text checkbox
- OpenAI Whisper + Whisper WebGPU dictation
- OpenAI o1 models support
- OpenAI base URL as settings
- DALL-E as tool
- GPT-4o support
- OpenAI model choice
- OpenAI links in settings
Meta/Llama:
- Meta/Llama AI support
- Llama 3.2 vision support
Azure AI:
- Azure AI support
fal.ai:
- fal.ai support (speech-to-text, text-to-image and text-to-video)
Smithery.ai:
- Smithery.ai MCP integration
ElevenLabs:
- ElevenLabs Text-to-Speech
OpenRouter:
- OpenRouter support
DeepSeek:
- DeepSeek support
Together.ai:
- Together.ai compatibility
Gemini:
- Gemini 2.0 Flash support
- Google Gemini API
Groq:
- Groq LLama 3.3 support
- Groq vision support
- Groq model update (8-Sep-2024)
- Groq API
xAI:
- xAI Grok Vision Model support
Ollama:
- Ollama function-calling
- Ollama support
- Ollama base URL as settings
- Ollama model pull
Replicate:
- Replicate video generation
- Replicate image generation
Hugging Face:
- Hugging face image generation
Anthropic:
- Anthropic Computer Use
- Anthropic function calling
- Anthropic Sonnet 3.5
- Anthropic API integration
Cerebras:
- Cerebras support
MistralAI:
- MistralAI function calling
- Mistral AI API integration
Custom Engines:
- Custom engines (OpenAI compatible)
- User defined parameters for custom engines
- Different default engine/model for commands
Model Management:
- Model Context Protocol
- Model defaults
- Favorite models
- Models refresh
- Model parameters (temperature...)
```
--------------------------------
### mitt Event Emitter
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
mitt is a tiny 200b (~1kB gzipped) functional event emitter for JavaScript. It provides a simple API for publishing and subscribing to events.
```javascript
import mitt from 'mitt';
const emitter = mitt();
// Subscribe to an event
const off = emitter.on('myEvent', (eventData) => {
console.log('Received myEvent:', eventData);
});
// Publish an event
emitter.emit('myEvent', { message: 'Hello from mitt!' });
// Unsubscribe from the event
off();
```
--------------------------------
### Agent and Command Functionality
Source: https://github.com/nbonamy/witsy/blob/main/README.md
This section covers the advanced agent capabilities and command execution features, including multi-step processing, scheduling, tool selection, and AI command customization with shortcuts.
```APIDOC
Agents:
- Agents (multi-step, scheduling...)
- Tool selection for chat
- LLM Tools support (OpenAI only)
- User feedback when running a tool
AI Commands:
- AI Commands copy/insert/replace shortcuts
- AI Commands redesign
- AI Commands with shortcut
- Shortcuts for AI Commands
- Edit commands
- Customized commands
- Import/Export commands
- Shift to switch AI command behavior
- New chat window for AI command
- Run commands with default models
- Cancel commands
- Show prompt used for image generation
- Redesigned Prompt window
```
--------------------------------
### Electron Forge CLI MIT License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
Contains the MIT License for the @electron-forge/cli package, detailing terms of use, modification, and distribution.
```License
The MIT License (MIT)
Copyright (c) 2016 Samuel Attard
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### vite-tsconfig-paths License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
MIT License for the vite-tsconfig-paths project. Grants permissions for use, modification, and distribution.
```text
MIT License
Copyright (c) Alec Larson
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```
--------------------------------
### SweetAlert2 Project License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This snippet details the MIT License for the SweetAlert2 project. It grants broad permissions for use, modification, and distribution, provided the original copyright and license notices are included.
```plaintext
The MIT License (MIT)
Copyright (c) 2014 Tristan Edwards & Limon Monte
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```
--------------------------------
### BSD 3-Clause License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
This code block outlines the BSD 3-Clause License, a permissive free software license. It details the conditions under which the software can be redistributed and used, emphasizing the requirement to retain copyright notices and disclaimers.
```bsd
Copyright (c) [year], [copyright holder name].
All rights reserved.
Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
```
--------------------------------
### MIT License
Source: https://github.com/nbonamy/witsy/blob/main/CREDITS.md
The MIT License is a permissive free software license that allows users to freely use, modify, distribute, and sublicense the software. It requires that the copyright notice and permission notice be included in all copies or substantial portions of the software.
```plaintext
The MIT License (MIT)
Copyright (c) 2016 Samuel Attard
Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
```