### Installing TypeAgent Core with Yarn (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/getting-started/index.md

This `bash` command installs the `@typeagent/core` package using Yarn, providing an alternative to npm for managing project dependencies. It achieves the same result as the npm installation.

```bash
yarn add @typeagent/core
```

--------------------------------

### Initializing and Processing Requests with TypeAgent (TypeScript)

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/getting-started/index.md

This TypeScript example demonstrates the basic usage of TypeAgent, including importing the `Agent` class, initializing an agent instance, and using `agent.processRequest()` to handle a user input string. It illustrates the core interaction pattern with the agent.

```typescript
import { Agent } from '@typeagent/core';

// Initialize your agent
const agent = new Agent({
  // Configuration options
});

// Handle user input
agent.processRequest('Create a new task for tomorrow');
```

--------------------------------

### Installing TypeAgent Core with npm (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/getting-started/index.md

This `bash` command installs the `@typeagent/core` package using npm, adding the TypeAgent library to your project's dependencies. It's the recommended method for Node.js projects.

```bash
npm install @typeagent/core
```

--------------------------------

### Setting up and Installing PNPM Dependencies for TypeAgent on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

These commands initialize pnpm for the project and install all necessary dependencies. `pnpm setup` configures pnpm, and `pnpm i` fetches the project's packages as defined in `package.json`.

```Shell
pnpm setup
```

```Shell
pnpm i
```

--------------------------------

### Installing Project Dependencies with PNPM - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command installs all required project dependencies as defined in the `package.json` file using pnpm. This is crucial for the project to function correctly and for subsequent build steps.

```Shell
pnpm i
```

--------------------------------

### Setting up PNPM Environment - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command performs initial setup for pnpm within the project context, potentially configuring its environment or installing necessary components. It's a preparatory step before installing project dependencies.

```Shell
pnpm setup
```

--------------------------------

### Cloning and Building TypeAgent Repository - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

These commands clone the TypeAgent repository, navigate into its TypeScript directory, and then use pnpm to set up, install dependencies, and build the project. The repository is cloned into ~/src/TypeAgent by default.

```Shell
git clone https://github.com/microsoft/TypeAgent ~/src/TypeAgent
cd ~/src/TypeAgent/ts
pnpm setup
pnpm i
pnpm run build
```

--------------------------------

### Running Windows Setup Batch File (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command executes the `setup.cmd` batch file on Windows to automate the installation process for the project's dependencies and environment.

```Shell
./setup.cmd
```

--------------------------------

### Running Linux/MacOS Setup Script (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command sources the `setup.sh` script on MacOS/Linux to automate the installation process, including virtual environment setup and dependency installation.

```Shell
source setup.sh
```

--------------------------------

### Setting up Node.js with NVM - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

These commands install Node Version Manager (NVM) and then use it to install the latest LTS version of Node.js. NVM allows managing multiple Node.js versions. The second command sources the NVM script to make it available in the current shell session.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
\. "$HOME/.nvm/nvm.sh"
nvm install --lts
```

--------------------------------

### Installing Dependencies for TypeAgent Docs (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/docs/README.md

This command navigates into the `docs` directory and installs the necessary Node.js dependencies for the TypeAgent documentation site using npm. This is a prerequisite step before starting local development.

```bash
cd docs
npm install
```

--------------------------------

### Installing NVM (Node Version Manager) on Linux

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Downloads and executes the NVM installation script, then sources the NVM setup script to make NVM available in the current shell session. NVM allows managing multiple Node.js versions.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
\. "$HOME/.nvm/nvm.sh"
```

--------------------------------

### Installing Git and Curl on Linux

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Installs the Git version control system and Curl utility using the apt package manager on Debian/Ubuntu-based systems. This is a prerequisite for cloning repositories and downloading files.

```Shell
sudo apt update
sudo apt install git curl
```

--------------------------------

### Cloning and Building TypeAgent Project

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Clones the TypeAgent repository, navigates into its TypeScript directory, enables Corepack, sets up pnpm, installs project dependencies, and finally builds the project. This prepares the TypeAgent application for execution.

```Shell
git clone https://github.com/microsoft/TypeAgent ~/src/TypeAgent
cd ~/src/TypeAgent/ts
corepack enable
pnpm setup
pnpm i
pnpm run build
```

--------------------------------

### Installing GNOME Keyring and Restarting WSL - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

This sequence installs the GNOME keyring, which is used for securely storing passwords and cryptographic keys. A full WSL restart is then performed to ensure the keyring service is properly initialized and available for applications like TypeAgent.

```Shell
sudo apt-get install -y gnome-keyring
exit
wsl --shutdown
wsl -d Ubuntu
cd ~/src/TypeAgent/ts
```

--------------------------------

### Initializing WSL2 Ubuntu Distribution - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

This command installs the Ubuntu distribution within WSL2. It's the first step to set up a Linux environment on Windows for development. Users will be prompted to set up a username and password after installation.

```Shell
wsl --install Ubuntu
```

--------------------------------

### Running Windows Setup Batch File

Source: https://github.com/microsoft/typeagent/blob/main/python/tts/speechT5/README.md

Executes the `setup.cmd` batch file on Windows to automate the installation and configuration of the local TTS server dependencies. This is the recommended one-step setup for Windows users.

```Batch
setup.cmd
```

--------------------------------

### Running TypeAgent Shell - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command starts the TypeAgent application's interactive shell, allowing users to interact with the TypeAgent services. It's the primary way to run the application after building.

```Shell
pnpm run shell
```

--------------------------------

### Installing Electron Build Dependencies - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

These commands update the package list and install essential libraries and tools required for building Electron applications on a Linux environment. These dependencies are crucial for Electron's runtime and development environment.

```Shell
sudo apt update
sudo apt-get install -y build-essential clang libdbus-1-dev libgtk-3-dev libnotify-dev libasound2-dev libcap-dev libcups2-dev libxtst-dev libxss1 libnss3-dev gcc-multilib g++-multilib curl gperf bison python3-dbusmock openjdk-8-jre
```

--------------------------------

### Configuring OpenAI API Key and Model (.env)

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/getting-started/index.md

This `.env` file configuration sets the `OPENAI_API_KEY` and `OPENAI_MODEL` environment variables. These are essential for TypeAgent to authenticate with the OpenAI API and specify the language model (e.g., GPT-4) to be used.

```env
OPENAI_API_KEY=your_api_key_here
OPENAI_MODEL=gpt-4
```

--------------------------------

### Starting TypeAgent Docs Development Server (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/docs/README.md

This command initiates the local development server for the TypeAgent documentation site. After execution, the site will typically be accessible in a web browser at `http://localhost:8080`.

```bash
npm start
```

--------------------------------

### Installing Python Dependencies

Source: https://github.com/microsoft/typeagent/blob/main/python/nprData/README.md

This command installs all necessary Python packages and libraries required for the project, as specified in the `requirements.txt` file. It's the first step to set up the development environment.

```Shell
pip install -r requirements.txt
```

--------------------------------

### Installing pnpm Package Manager

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

Installs the pnpm package manager globally using npm and then runs the pnpm setup command to configure it for the current environment. This is a prerequisite for building TypeAgent.

```Shell
npm i -g pnpm && pnpm setup
```

--------------------------------

### Installing Node.js LTS with NVM on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command uses NVM to install the latest Long Term Support (LTS) version of Node.js. This ensures a stable and recommended Node.js environment for TypeAgent development.

```Shell
nvm install --lts
```

--------------------------------

### Installing LTS Node.js with NVM

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Installs the latest Long Term Support (LTS) version of Node.js using NVM. This command ensures a stable and recommended Node.js environment is set up for development.

```Shell
nvm install --lts
```

--------------------------------

### Installing Elasticsearch Locally - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

This command downloads and executes a script from elastic.co to set up a local Elasticsearch instance. It uses `curl` to fetch the script and pipes it to `sh` for execution, providing a quick way to get Elasticsearch running for development or testing.

```Shell
curl -fsSL https://elastic.co/start-local | sh
```

--------------------------------

### Building TypeAgent Project with PNPM - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command executes the 'build' script defined in the project's `package.json` using pnpm. This typically compiles the TypeScript code into JavaScript and prepares the project for execution or deployment.

```Shell
pnpm run build
```

--------------------------------

### Configuring Azure OpenAI Service Credentials (.env)

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/getting-started/index.md

This `.env` file configuration provides the necessary environment variables (`AZURE_OPENAI_API_KEY`, `AZURE_OPENAI_ENDPOINT`, `AZURE_OPENAI_DEPLOYMENT`) for TypeAgent to connect to an Azure OpenAI Service instance. It ensures proper authentication and resource targeting.

```env
AZURE_OPENAI_API_KEY=your_api_key_here
AZURE_OPENAI_ENDPOINT=your_endpoint_here
AZURE_OPENAI_DEPLOYMENT=your_deployment_name
```

--------------------------------

### Launching Local Whisper Service (Python)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command starts the Faster Whisper service locally, exposing a REST endpoint for transcription. It should be run after all prerequisites and dependencies are installed.

```Python
python faster-whisper.py
```

--------------------------------

### Starting TypeAgent CLI or Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This snippet shows alternative commands to launch either the TypeAgent interactive command-line interface (CLI) or the TypeAgent shell. These environments are essential for managing and interacting with installed agents, including the Echo agent.

```bash
pnpm run cli interactive
pnpm run shell
```

--------------------------------

### Setting up NVM for Node.js on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This snippet installs NVM (Node Version Manager) using a curl command and then sources the NVM script to make it available in the current shell session. NVM is essential for managing multiple Node.js versions.

```Shell
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
```

```Shell
\. "$HOME/.nvm/nvm.sh"
```

--------------------------------

### Running TypeAgent Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Executes the TypeAgent shell. For Ubuntu 24.04, the `--noSandbox` flag is used due to a known Electron issue; otherwise, the standard command is used. This starts the TypeAgent application.

```Shell
pnpm run shell --noSandbox
```

```Shell
pnpm run shell
```

--------------------------------

### Running TypeAgent Shell on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command starts the TypeAgent application's interactive shell interface using pnpm. It allows users to interact directly with the TypeAgent services and functionalities.

```Shell
pnpm run shell
```

--------------------------------

### Installing FFMpeg and Codecs on Linux (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command installs `ffmpeg` and `libavcodec-extra` using `apt-get` on Linux, which are required for the `pydub` library used for audio manipulation.

```Shell
apt-get -y install ffmpeg libavcodec-extra
```

--------------------------------

### Running Chat Example with PNPM - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

After setting the necessary environment variables (`OPENAI_MODEL_EMBEDDING_DIM` and `ELASTIC_URI`), this command executes the `runchat` script defined in the project's `package.json` using `pnpm`. This typically starts the chat application that utilizes the Elasticsearch memory provider.

```Shell
pnpm run runchat
```

--------------------------------

### Installing NVIDIA cuDNN on Linux (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command installs `cudnn9-cuda-12` on Linux. It's a prerequisite for leveraging NVIDIA GPUs for accelerated model inference and requires prior setup of the NVIDIA network repository.

```Shell
apt-get -y install cudnn9-cuda-12
```

--------------------------------

### Building TypeAgent Project with PNPM on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command executes the build script defined in the TypeAgent project's `package.json` using pnpm. It compiles the source code into a runnable format, preparing the application for execution.

```Shell
pnpm run build
```

--------------------------------

### Running the List Agent Visualization Page

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/viewList/README.md

This command initiates the local development server for the List agent visualization webpage. It requires the 'pnpm' package manager to be installed and executed from the project's root directory to view the page in action.

```Shell
pnpm run start
```

--------------------------------

### Installing Dependencies with pnpm

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/help/dev.md

This snippet demonstrates how to install or update project dependencies using pnpm. Running `pnpm i` is recommended after syncing the repository to resolve common build issues and ensure all dependencies and references are up-to-date.

```Shell
pnpm i
```

--------------------------------

### Linking and Building Echo Agent Package

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This sequence of commands is executed within the Echo agent's package directory. It first links the Echo agent to the globally available `@typeagent/agent-sdk`, then installs its specific dependencies, and finally builds the Echo agent project, preparing it for installation into the TypeAgent environment.

```bash
npm link @typeagent/agent-sdk
npm install
npm run build
```

--------------------------------

### Installing FFMpeg on Windows (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command uses `winget` to install FFMpeg, a multimedia framework required for audio processing, on Windows systems. It's a prerequisite for the `pydub` library.

```Shell
winget install ffmpeg
```

--------------------------------

### Linking Agent SDK Module (NPM)

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/agentExamples/measure/README.md

This command links the local '@typeagent/agent-sdk' module, essential for agent development, into the global 'node_modules' directory. This step ensures the Measure example agent can access the necessary SDK functionalities.

```bash
npm link @typeagent/agent-sdk
```

--------------------------------

### Cloning TypeAgent Repository - Git Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command clones the TypeAgent GitHub repository into the specified local directory (C:\src\TypeAgent). It's the initial step to obtain the source code for local development and building.

```Shell
git clone https://github.com/microsoft/TypeAgent C:\src\TypeAgent
```

--------------------------------

### Running TypeAgent Shell - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

This command executes the TypeAgent shell script using pnpm. It's the final step to launch the TypeAgent application, which may prompt for a keyring password setup if not already configured.

```Shell
pnpm run shell
```

--------------------------------

### Running TypeAgent CLI via npm/npx

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/cli/README.md

This snippet shows alternative ways to run the TypeAgent CLI using `npx` or `npm` scripts. `npx .` executes the default binary defined in `package.json` from the current directory, `npx agent-cli-dev` runs the development version via `npx`, and `npm run start` executes a predefined 'start' script in `package.json`. These methods offer convenience with slightly more overhead.

```bash
npx .
```

```bash
npx agent-cli-dev
```

```bash
npm run start
```

--------------------------------

### Starting TypeAgent Server Locally (npm)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/api/README.md

This command initiates the TypeAgent HTTP API server for local development. After execution, the server will be accessible via a web browser at `http://localhost:3000`, enabling local testing and interaction with the agent.

```Shell
npm run start
```

--------------------------------

### Navigating to TypeAgent TypeScript Directory on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command changes the current working directory to the TypeScript-specific part of the TypeAgent repository. Subsequent build and installation commands are expected to be executed from this location.

```Shell
cd /d ~/src/TypeAgent/ts
```

--------------------------------

### Running MacOS/Linux Setup Shell Script

Source: https://github.com/microsoft/typeagent/blob/main/python/tts/speechT5/README.md

Sources the `setup.sh` script on MacOS or Linux to set up the environment and install necessary packages for the local TTS server. Using `source` ensures that environment variables set by the script persist in the current shell.

```Shell
source setup.sh
```

--------------------------------

### Opening TypeAgent Project in VSCode

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Linux.md

Launches Visual Studio Code and opens the TypeAgent TypeScript project directory. This command is used to begin development work on the TypeAgent repository.

```Shell
code ~/src/TypeAgent/ts
```

--------------------------------

### Running TypeAgent CLI from Workspace Root (pnpm)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/cli/README.md

This snippet shows how to execute the TypeAgent CLI directly from the project's workspace root (`ts` directory) using `pnpm`. `pnpm run cli` starts the production version, while `pnpm run cli:dev` starts the development version, which might include additional debugging features or unbuilt changes. This method requires the project to be built first.

```bash
pnpm run cli
```

```bash
pnpm run cli:dev
```

--------------------------------

### Installing Python Dependencies

Source: https://github.com/microsoft/typeagent/blob/main/python/tts/speechT5/README.md

Installs all Python packages listed in the `requirements.txt` file. This command fetches and installs the necessary libraries for the SpeechT5 local TTS server, ensuring all dependencies are met.

```Shell
pip install -r requirements.txt
```

--------------------------------

### Starting Whisper Client Web UI (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command uses `pnpm` to start the web user interface for the `whisperClient`, allowing interaction with the local whisper service.

```Shell
pnpm run start
```

--------------------------------

### Installing Python Audio Dependencies on Linux (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command installs `python3-pyaudio` and `portaudio19-dev` using `apt-get` on Linux, which are necessary for the `pyaudio` library used in the project.

```Shell
apt-get -y install python3-pyaudio portaudio19-dev
```

--------------------------------

### Installing and Configuring Echo Agent in TypeAgent

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

These commands are executed within the TypeAgent Shell or CLI. The first command installs the Echo agent by specifying its package path, and the second command lists all configured agents to verify that the Echo agent has been successfully installed and is enabled.

```TypeAgent Shell
@install echo <path to echo package>
@config agent
```

--------------------------------

### Cloning TypeAgent Repository on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command clones the TypeAgent GitHub repository into the specified directory (`~/src/TypeAgent`). This is the initial step to obtain the project's source code on the local machine.

```Shell
git clone https://github.com/microsoft/TypeAgent ~/src/TypeAgent
```

--------------------------------

### Installing Python Dependencies (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command uses `pip` to install all required Python packages listed in the `requirements.txt` file, ensuring all project dependencies are met.

```Shell
pip install -r requirements.txt
```

--------------------------------

### Installing PortAudio on MacOS (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command uses `brew` to install `portaudio` on MacOS, which is a dependency for the `pyaudio` library required by the project for audio input.

```Shell
brew install portaudio
```

--------------------------------

### Installing TypeAgent Dependencies

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

Installs all project dependencies for TypeAgent using pnpm. This command should be run in the main TypeScript directory after cloning the repository.

```Shell
pnpm i
```

--------------------------------

### Linking TypeAgent Module (NPM)

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/agentExamples/measure/README.md

This command links the local '@typeagent' module into the global 'node_modules' directory, making it available for development and testing within the project. It's a prerequisite for running the Measure example agent.

```bash
npm link @typeagent
```

--------------------------------

### Listing Installed VSCode Extensions (CLI)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/coda/README.md

This command lists all currently installed VSCode extensions, allowing verification of the CODA extension's installation. It can be used to confirm `aisystems.copilot-coda` is present.

```Shell
code --list-extensions
```

--------------------------------

### Listing Available Explainer Implementations (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/eval-1/source/dispatcher/README.md

This command displays the usage for configuring explainers and lists the available explainer implementations, such as 'v4' and 'v5'. It helps users discover which explainer versions they can select for their TypeAgent Dispatcher setup.

```bash
🤖🚧💾  [📅💊📩📝👀🪟⚛️💬🔧]>@config explainer
Usage: @config explainer name <explainer>
   <explainer>: v4, v5
```

--------------------------------

### Configuring WSL2 to Use Windows Fonts - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

These commands create a font configuration file (local.conf) that instructs WSL2 to include Windows fonts from the /mnt/c/Windows/Fonts directory. This allows Linux applications running in WSL2 to access and utilize fonts installed on the Windows host system.

```Shell
echo '<?xml version="1.0"?><!DOCTYPE fontconfig SYSTEM "fonts.dtd"><fontconfig><dir>/mnt/c/Windows/Fonts</dir></fontconfig>' > local.conf
sudo mv local.conf /etc/fonts
```

--------------------------------

### Enabling Corepack for PNPM - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command enables Corepack, a tool that manages package manager versions (like pnpm) for Node.js projects. It ensures that the correct package manager version is used automatically, simplifying dependency management.

```Shell
corepack enable
```

--------------------------------

### Listing Available Explainer Implementations

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/dispatcher/README.md

This snippet illustrates the use of the @config explainer command without parameters to display the usage syntax and list all available explainer implementations. It informs the user that 'v4' and 'v5' are the selectable options for the explainer, guiding them on how to configure this setting.

```bash
🤖🚧💾  [📅💊📩📝👀🪟⚛️💬🔧]>@config explainer
Usage: @config explainer name <explainer>
   <explainer>: v4, v5
```

--------------------------------

### Translating Natural Language to Agent Action in CLI (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/eval-1/source/dispatcher/README.md

This example shows a user interacting with the TypeAgent CLI, requesting a meeting setup using natural language. The dispatcher translates this request into a structured `addEvent` action with specific parameters, which is then presented to the user for acceptance. It illustrates the core natural language processing capability.

```bash
[calendar]🤖> can you setup a meeting between 2-3PM
Generating translation using GPT for 'can you setup a meeting between 2-3PM'
🤖: can you setup a meeting between 2-3PM => addEvent({"event":{"day":"today","timeRange":["14:00","15:00"],"description":"meeting"}}) [9.531s]
Accept? (y/n)
```

--------------------------------

### Navigating to TypeAgent TypeScript Directory - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command changes the current directory to the TypeScript source folder within the cloned TypeAgent repository. This is a prerequisite for executing pnpm commands specific to the TypeScript project.

```Shell
cd /d C:\src\TypeAgent\ts
```

--------------------------------

### Starting Local SpeechT5 TTS Service

Source: https://github.com/microsoft/typeagent/blob/main/python/tts/speechT5/README.md

Executes the `speechT5.py` Python script to start the local Text-to-Speech service. This script initializes the SpeechT5 model and makes it available for the TypeAgent shell to connect and utilize for local TTS.

```Python
python speechT5.py
```

--------------------------------

### Installing Pyright Globally via npm

Source: https://github.com/microsoft/typeagent/blob/main/python/ta/README.md

This command installs the Pyright static type checker globally using the Node Package Manager (npm). Pyright is a fast and comprehensive type checker for Python, written in TypeScript.

```Shell
npm install -g pyright
```

--------------------------------

### Adding Environment Variables to .bashrc - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

These commands append configuration lines to the user's .bashrc file. They ensure proper D-Bus environment activation, set the UI cursor size, and configure the Gallium driver for better graphics performance, particularly useful for GUI applications in WSL2.

```Shell
echo 'dbus-update-activation-environment --all > /dev/null 2>&1' >> ~/.bashrc
echo 'export XCURSOR_SIZE=16' >> ~/.bashrc
echo 'export GALLIUM_DRIVER=d3d12' >> ~/.bashrc
```

--------------------------------

### Opening TypeAgent Project in VSCode - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-Windows.md

This command opens the specified directory (C:\src\TypeAgent\ts) in Visual Studio Code. It's used to quickly launch the development environment for the TypeAgent TypeScript project, enabling code editing and debugging.

```Shell
code C:\src\TypeAgent\ts
```

--------------------------------

### Installing Python 3.12 on Ubuntu

Source: https://github.com/microsoft/typeagent/blob/main/python/ta/README.md

This shell command installs Python version 3.12 or higher on Ubuntu-based systems using the `apt` package manager. It requires superuser privileges to modify system packages.

```Shell
sudo apt install python3.12
```

--------------------------------

### Opening TypeAgent Project in VSCode on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command opens the TypeAgent TypeScript project directory in Visual Studio Code. It's a standard step for developers to begin working on or exploring the codebase within their IDE.

```Shell
code ~/src/TypeAgent/ts
```

--------------------------------

### Building TypeAgent TypeScript Code

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This snippet provides commands to navigate to the TypeAgent TypeScript source directory, install project dependencies using pnpm, and then build the TypeScript project. This build step is a prerequisite for linking and using TypeAgent packages.

```bash
pnpm i
pnpm run build
```

--------------------------------

### Enabling Corepack for Package Management on MacOS

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-macOS.md

This command enables Corepack, a tool that helps manage package managers like pnpm, yarn, and npm. It's a prerequisite for using pnpm, which is used for dependency management in the TypeAgent project.

```Shell
corepack enable
```

--------------------------------

### Loading Sample Podcast Data and Querying with KnowPro CLI

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/chat/README.md

This snippet demonstrates how to load a sample podcast into the KnowPro RAG index, perform a search for terms like 'book' (optionally filtered by 'fantasy' genre), and then query the index to list all book names. It showcases the basic workflow for interacting with the KnowPro podcast memory.

```CLI
@kpPodcastLoadSample

@kpSearchTerms book

@kpSearchTerms book --genre fantasy

@kpAnswer --query "List the names of all books"
```

--------------------------------

### Installing Gnome Keyring for Authentication Cache on Linux/WSL

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

This snippet provides shell commands to install `gnome-keyring` on Linux or WSL2 environments. This package is a prerequisite for TypeAgents that use `@azure/identity` and `@azure/identity-cache-persistence` to securely cache authentication secrets locally. Users are prompted to set a password for the keyring upon first use.

```shell
sudo apt-get update
  sudo apt install -y gnome-keyring
```

--------------------------------

### Running Browser Extension in Development Mode with pnpm

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/browser/README.md

This command starts the development server for the browser extension, enabling debug support and typically hot-reloading for a more efficient development workflow.

```Shell
pnpm run dev
```

--------------------------------

### Opening TypeAgent Project in VSCode Remote - Shell

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/setup/setup-WSL2.md

This command launches Visual Studio Code, opening the TypeAgent TypeScript project directory within the WSL environment. It leverages the VSCode Remote Development extension to provide a seamless development experience directly from Windows.

```Shell
code ~/src/TypeAgent/ts
```

--------------------------------

### Running TypeAgent Shell with pnpm

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/shell/README.md

This command starts the TypeAgent Shell application using pnpm. It is the primary way to launch the UI for the interactive agent, providing the user interface for interacting with the TypeAgent system.

```shell
pnpm run shell
```

--------------------------------

### Configuring Pip for PyTorch (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command configures `pip` to include the PyTorch CUDA 12.1 wheel index URL, ensuring that the correct PyTorch version with CUDA support can be installed.

```Shell
pip config --site set global.extra-index-url https://download.pytorch.org/whl/cu121
```

--------------------------------

### Building TypeAgent Docs for Production (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/docs/README.md

This command navigates into the `docs` directory and executes the build script defined in `package.json` for the TypeAgent documentation site. The output, a static site, will be generated in the `docs/_site` directory, ready for deployment.

```bash
cd docs
npm run build
```

--------------------------------

### Running Spelunker CLI for Codebase Analysis (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/README.md

This shell script demonstrates how to interact with the TypeAgent CLI to run the `spelunker` agent. It navigates to the `ts` directory, starts the interactive CLI, configures Spelunker, focuses it on the copied source directory, and then requests a summary of the codebase before exiting.

```shell
$ cd ~/TypeAgent/ts
$ pnpm run cli interactive
...
{{...}}> @config request spelunker
Natural langue request handling agent is set to 'spelunker'
{{<> SPELUNKER}}> .focus ~/TypeAgent/ts/packages/agents/spelunker/evals/eval-1/source/dispatcher
Focus set to /home/gvanrossum/TypeAgent/ts/packages/agents/spelunker/evals/eval-1/source/dispatcher
{{<> SPELUNKER}}> Summarize the codebase
...
(an enormous grinding of gears)
...
The codebase consists of various TypeScript files that define interfaces, functions, classes, and tests for a system that handles commands, agents, and translations. Here is a summary of the key components:
...
References: ...
{{<> SPELUNKER}}> ^C
 ELIFECYCLE  Command failed with exit code 130.
 ELIFECYCLE  Command failed with exit code 130.
```

--------------------------------

### Example Python `__len__` Method for Hash Collision Illustration

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/design.md

This Python snippet provides an example of a common method (`__len__`) that might appear identically in multiple classes or files. It is used to illustrate a scenario where hashing only the text content of a chunk could lead to hash collisions, emphasizing the necessity of including contextual information like filename and parent names in the hashing input to ensure unique chunk identification.

```python
    def __len__(self):
        return len(self._data)
```

--------------------------------

### Initializing Whisper Recognizer and Handling Events - JavaScript

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/whisperClient/public/index.html

This snippet initializes a `WhisperRecognizer` instance upon DOM content loading. It sets up event handlers for `onRecognizing` (for real-time transcription updates) and `onRecognized` (for final transcription and re-enabling the record button). It also defines the click handler for a 'record' button to start the recording process.

```JavaScript
document.addEventListener("DOMContentLoaded", (event) => {
  const whisperClient = new WhisperRecognizer();
  whisperClient.onRecognizing((data) => {
    transcriptionResult.innerText = data.text;
  });
  whisperClient.onRecognized((data) => {
    transcriptionResult.innerText = data.text;
    record.disabled = false;
  });
  record.onclick = (e) => {
    record.disabled = true;
    whisperClient.startRecording();
  };
});
```

--------------------------------

### Scraping TripAdvisor in Discovery Mode using CLI

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/microdataExtract/README.md

This command initiates an automatic discovery and scraping process for restaurant data from TripAdvisor. Users can optionally specify a base URL to start the discovery from and limit the number of pages to scrape.

```bash
pnpm start scrape --mode=discovery
pnpm start scrape --mode=discovery --base-url="https://www.tripadvisor.com/Restaurants-g60878-Seattle_Washington.html" --pages=5
```

--------------------------------

### Starting Interactive Prompt in TypeAgent CLI

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

This command launches the interactive prompt within the TypeAgent CLI. It enables users to interact with TypeAgents using natural language interfaces directly from the console.

```shell
pnpm run cli -- interactive
```

--------------------------------

### Initializing Local Qdrant Instance

Source: https://github.com/microsoft/typeagent/blob/main/python/nprData/README.md

This command executes the `qdrant_handler.py` script, which is responsible for setting up or interacting with a local Qdrant vector database instance. A running Qdrant instance is essential for querying the generated corpus.

```Shell
python qdrant_handler.py
```

--------------------------------

### Logging into Azure CLI for Key Vault Setup

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

This command authenticates the user with Azure CLI, which is a prerequisite for interacting with Azure services like Key Vault. It establishes the necessary session for subsequent Azure commands.

```Shell
az login
```

--------------------------------

### Resetting Git Repository to Clean State

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/help/dev.md

This command is used to reset the Git repository to a clean state, which can be helpful if issues arise during dependency installation or building. Users should ensure all uncommitted changes are saved before executing `git clean`.

```Shell
git clean
```

--------------------------------

### Configuring Pip for PyTorch CUDA 12.1

Source: https://github.com/microsoft/typeagent/blob/main/python/tts/speechT5/README.md

Configures pip to include the PyTorch CUDA 12.1 wheel index as an extra index URL. This ensures that pip can find and install PyTorch packages compatible with CUDA 12.1, which is a prerequisite for SpeechT5.

```Shell
pip config --site set global.extra-index-url https://download.pytorch.org/whl/cu121
```

--------------------------------

### Deploying Azure Resources with Azure CLI

Source: https://github.com/microsoft/typeagent/blob/main/ts/tools/scripts/armTemplates/README.md

This Azure CLI command initiates a subscription-level deployment of an Azure Resource Manager (ARM) template. It uses 'template.json' to provision all necessary Azure services for TypeAgent Shell into a resource group, typically named 'typeagent-eastus', within the 'eastus' Azure region. Prior to execution, ensure Azure CLI is installed and authenticated via 'az login'.

```Azure CLI
az deployment sub create --template-file template.json --location eastus
```

--------------------------------

### Uninstalling Echo Agent from TypeAgent

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This command, executed within the TypeAgent Shell or CLI, uninstalls the previously installed Echo agent. Upon uninstallation, the agent is removed from the active list, and the TypeAgent environment is reloaded to reflect the change.

```TypeAgent Shell
@uninstall echo
```

--------------------------------

### Automating Just-in-time Access Elevation with TypeAgent

Source: https://github.com/microsoft/typeagent/blob/main/ts/README.md

This npm script executes the elevate.js script, which automates the process of elevating privileges using Azure Entra Privileged Identity Management (PIM). It's designed for a typical developer workflow to gain temporary, just-in-time access at the start of a workday, based on configurations in tools/scripts/elevate.config.json.

```Shell
npm run elevate
```

--------------------------------

### Running Schema Studio Application

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/schemaStudio/ReadMe.md

This command executes the main JavaScript application for Schema Studio using Node.js. It's the standard way to launch the application from the command line.

```Shell
node dist/main.js
```

--------------------------------

### Running the List Visualization Webpage (pnpm)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/turtle/README.md

This command initiates the local development server for the List visualization webpage using the pnpm package manager. It is a prerequisite for viewing the page in action in a web browser.

```Shell
pnpm run start
```

--------------------------------

### Initializing Evaluation Database (Python)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/README.md

This Python script initializes or re-initializes the evaluation database. Using the `--overwrite` flag allows for recomputing the `Hashes` table and recopying `Files`, `Chunks`, and `Blobs` tables while preserving `Questions` and `Scores`, preparing the database for subsequent evaluation steps.

```python
$ python3 ./evals/src/evalsetup.py --overwrite
Prefix: /home/gvanrossum/TypeAgent/ts/packages/agents/spelunker/evals/eval-1/source/
Database: evals/eval-1/eval.db
...
(More logging)
...
```

--------------------------------

### Running the Knowledge Visualizer (KV) Tool via pnpm

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/knowledgeVisualizer/README.md

This snippet demonstrates how to execute the Knowledge Visualizer (KV) tool using the 'pnpm' package manager. It's primarily used for debugging and browsing stored knowledge.

```Shell
pnpm run kv
```

--------------------------------

### Indexing Podcast Content - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

This command indexes the content from a previously generated 'turn directory', creating entities, actions, and topics. The `--sourcePath` argument points to the directory containing the processed turns. This step populates the memory provider with structured podcast data.

```Shell
@podcastIndex --sourcePath <path_to_turns>
```

--------------------------------

### Building Browser Extension with pnpm

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/browser/README.md

This command compiles the browser extension source code into a distributable package. It's the standard build process for production or release versions.

```Shell
pnpm run build
```

--------------------------------

### Preparing Source Files for Evaluation (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/README.md

This shell script prepares the source directory for evaluation by creating necessary directories, copying the `dispatcher` package, and removing irrelevant files like `dist`, `node_modules`, and `package.json` to optimize for Spelunker's analysis and prevent policy test failures.

```shell
$ mkdir evals/eval-1
$ mkdir evals/eval-1/source
$ cp -r ~/TypeAgent/ts/packages/dispatcher evals/eval-1/source/
$ rm -rf evals/eval-1/source/dispatcher/{dist,node_modules}
$ rm -rf evals/eval-1/source/dispatcher/package.json
```

--------------------------------

### Changing TypeAgent LLM Translation Model

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/help/cheatSheet.html

This command allows you to change the Large Language Model (LLM) used for translation within TypeAgent. The example sets it to 'GPT_4_O'.

```TypeAgent CLI
@config translation model set GPT_4_O
```

--------------------------------

### Building the TypeAgent Project

Source: https://github.com/microsoft/typeagent/blob/main/python/ta/README.md

This `make` command initiates the build process for the 'typeagent' project. It compiles source code and generates distribution artifacts, such as a Python wheel file, typically found in the `dist/` directory.

```Shell
make all
```

--------------------------------

### Displaying CLI Help and Version Information

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/microdataExtract/README.md

These commands provide essential information about the CLI tool, including general help, specific command help, and the current version of the application.

```bash
# Show help
pnpm start help

# Show help for a specific command
pnpm start help [COMMAND]

# Show version
pnpm start --version
```

--------------------------------

### Linking TypeAgent Agent SDK Globally

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

These commands navigate to the `agent-sdk` package directory within the TypeAgent TypeScript source and create a global symbolic link using `npm link`. This action makes the SDK package available for other local projects, such as the Echo agent, to consume as a dependency.

```bash
npm link
```

--------------------------------

### Searching Podcast Content - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

This command performs a search operation on the imported podcast content using the specified query. The `--query` argument takes the search string. This allows users to retrieve relevant information from the indexed podcast data.

```Shell
@podcastSearch --query <query>
```

--------------------------------

### Deploying VSCode Extension Locally (pnpm)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/coda/README.md

This command deploys the VSCode extension to your local VSCode environment for testing. Run it from the project's root directory.

```Shell
pnpm run deploy:local
```

--------------------------------

### Configuring TypeAgent Echo Agent Package with npm

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This `package.json` defines the Echo agent's metadata, dependencies, and build scripts. It specifies entry points for the agent's manifest and action handlers, crucial for TypeAgent integration and project management.

```JSON
{
  "name": "echo",
  "version": "0.0.1",
  "description": "Echo example for TypeAgent",
  "license": "MIT",
  "author": "Microsoft",
  "type": "module",
  "exports": {
    "./agent/manifest": "./src/echoManifest.json",
    "./agent/handlers": "./dist/echoActionHandler.js"
  },
  "scripts": {
    "build": "npm run tsc",
    "clean": "rimraf --glob dist *.tsbuildinfo *.done.build.log",
    "tsc": "tsc -b"
  },
  "keywords": [],
  "dependencies": {
    "@typeagent/agent-sdk": "0.0.1"
  },
  "devDependencies": {
    "rimraf": "^5.0.5",
    "typescript": "^5.4.2"
  }
}
```

--------------------------------

### Building Whisper Client Project (Shell)

Source: https://github.com/microsoft/typeagent/blob/main/python/stt/whisperService/README.md

This command uses `pnpm` to build the TypeScript-based `whisperClient` project, compiling its source code into a runnable format.

```Shell
pnpm run build
```

--------------------------------

### Navigating to Scripts Directory (Windows)

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/schemaStudio/ReadMe.md

This command changes the current working directory to the 'scripts' folder, which contains the 'run.cmd' wrapper script necessary for executing Schema Studio commands on Windows.

```Shell
cd scripts
```

--------------------------------

### Running TypeAgent CLI Directly (Windows)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/cli/README.md

This snippet illustrates how to execute the TypeAgent CLI directly on Windows systems. `.\bin\run` runs the built version, while `.\bin\dev` runs the development version using `ts-node` without requiring a prior build. This method is useful for direct execution within the CLI directory.

```bash
.\bin\run
```

```bash
.\bin\dev
```

--------------------------------

### Implementing TypeAgent Echo Agent Action Handler in TypeScript

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/tutorial/agent.md

This TypeScript file implements the core logic for the Echo agent, providing functions to initialize the agent's context and execute defined actions. It handles the `echoGen` action by incrementing an echo count and returning the echoed text, demonstrating how to interact with `ActionContext` and generate results.

```TypeScript
import { ActionContext, AppAgent, TypeAgentAction } from "@typeagent/agent-sdk";
import {
  createActionResultFromTextDisplay,
  createActionResultFromError,
} from "@typeagent/agent-sdk/helpers/action";
import { EchoAction } from "./echoActionSchema.js";

export function instantiate(): AppAgent {
  return {
    initializeAgentContext: initializeEchoContext,
    executeAction: executeEchoAction,
  };
}

type EchoActionContext = {
  echoCount: number;
};

async function initializeEchoContext(): Promise<EchoActionContext> {
  return { echoCount: 0 };
}

async function executeEchoAction(
  action: TypeAgentAction<EchoAction>,
  context: ActionContext<EchoActionContext>
) {
  // The context created in initializeEchoContext is returned in the action context.
  const echoContext = context.sessionContext.agentContext;
  switch (action.actionName) {
    case "echoGen":
      const displayText = `>> Echo ${++echoContext.echoCount}: ${action.parameters.text}`;
      return createActionResultFromTextDisplay(displayText, displayText);

    default:
      return createActionResultFromError("Unable to process the action");
  }
}
```

--------------------------------

### Running Manual Scoring Tool for Evaluation Questions (Python)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/README.md

This Python script launches the manual scoring tool, enabling users to score individual text chunks against a specific test question. The tool prompts for a binary input (0/1 or y/n) for each chunk, facilitating a detailed and interactive evaluation of agent responses.

```python
$ python3 evals/src/evalscore.py --question "Summarize the codebase"
```

--------------------------------

### Converting Podcast Transcript to Turns - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

This command converts a raw podcast transcript file into a structured 'turn directory'. The `--sourcePath` argument specifies the location of the input transcript file. This is the first step in processing podcast content for indexing.

```Shell
@podcastConvert --sourcePath <path_to_podcast_transcript>
```

--------------------------------

### TypeAgent Docs Directory Structure (Text)

Source: https://github.com/microsoft/typeagent/blob/main/docs/README.md

This snippet illustrates the hierarchical directory structure of the TypeAgent documentation site. It outlines the purpose of key folders like `_data`, `_includes`, `assets`, and `content`, along with important configuration files such as `.eleventy.js` and `package.json`.

```text
docs/
├── _data/              # Global data files
│   ├── navigation.js   # Navigation structure
│   └── site.json       # Site metadata
├── _includes/          # Layout templates
│   ├── base.njk        # Base layout
│   └── docs.njk        # Documentation layout
├── assets/             # Static assets
│   └── css/
│       └── style.css   # CSS styles
├── content/            # Markdown content
│   ├── index.md        # Homepage/Documentation index
│   ├── getting-started/
│   │   └── index.md    # Getting started guide
│   └── ...             # Other documentation pages
├── .eleventy.js        # Eleventy configuration
├── .gitignore        # Git ignore file
└── package.json        # Node.js dependencies
```

--------------------------------

### Generating Utterance Variations (Windows)

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/schemaStudio/ReadMe.md

This command uses the 'run.cmd' wrapper to generate variations for a given user utterance. It allows specifying relevant facets (e.g., 'Composer', 'Piece', 'Slang') and the depth of variation generation.

```Batch
run.cmd @variations "Yo, play me some Goldberg Variations by Bach!" --facets "Composer, Piece, Slang" --depth 2
```

--------------------------------

### Viewing Podcast Entities - Shell

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/memoryProviders/src/elastic/README.md

This command allows users to inspect the structured entities, actions, and topics that have been created and indexed from the podcast content. It provides a way to verify the data structure after the indexing process.

```Shell
@podcastEntities
```

--------------------------------

### Generating Utterances from Schema (Windows)

Source: https://github.com/microsoft/typeagent/blob/main/ts/examples/schemaStudio/ReadMe.md

This command utilizes the 'run.cmd' wrapper script to generate a specified number of user utterances based on a predefined schema. The '--count 25' argument requests 25 utterances.

```Batch
run.cmd @fromSchema --count 25
```

--------------------------------

### Configuring Explainer Implementation (Bash)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/spelunker/evals/eval-1/source/dispatcher/README.md

This command demonstrates how to switch the active explainer implementation within the TypeAgent CLI to 'v4'. Explainers are used by the dispatcher to elaborate on generated translations. This command allows users to experiment with different explainer versions for varied explanation outputs.

```bash
[📅💊📩📝👀🪟⚛️💬🔧]> @config explainer name v4

[📅💊📩📝👀🪟⚛️💬🔧 (explainer: v4)]>
```

--------------------------------

### Styling Extension Options Page (CSS)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/agents/browser/src/extension/options.html

This CSS snippet defines the basic layout and styling for an extension's options page. It sets padding and width for the body, and defines widths for container, header, and actions sections, ensuring a consistent visual presentation for user settings.

```CSS
body { padding: 15px; width: 350px; } .container { width: 100%; } .header { margin-bottom: 20px; } .actions { margin-top: 20px; }
```

--------------------------------

### Running TypeAgent CLI Directly (Linux)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/cli/README.md

This snippet illustrates how to execute the TypeAgent CLI directly on Linux systems. `./bin/run.js` runs the built version, while `./bin/dev.js` runs the development version using `ts-node` without requiring a prior build. This method is useful for direct execution within the CLI directory.

```bash
./bin/run.js
```

```bash
./bin/dev.js
```

--------------------------------

### Building the VSCode Extension (pnpm)

Source: https://github.com/microsoft/typeagent/blob/main/ts/packages/coda/README.md

This command builds the VSCode extension. It should be executed in the project's root directory where the `pnpm-lock.yaml` file is located.

```Shell
pnpm run build
```

--------------------------------

### Showing General TypeAgent Help

Source: https://github.com/microsoft/typeagent/blob/main/docs/content/help/cheatSheet.html

This command displays general help information for the TypeAgent application, listing available commands and their basic usage.

```TypeAgent CLI
@help
```