### Get Started Link

Source: https://docs.upstreet.ai/migration-guides/tavern

Provides the URL for the Upstreet Agents SDK installation guide.

```html
<a class="underline font-bold" href="https://docs.upstreet.ai/install">Get started →</a>
```

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

### Upstreet AI Quickstart Guide

Source: https://docs.upstreet.ai/api/components/agent

Guides for getting started with Upstreet AI, covering initial setup, agent creation, customization, testing, and deployment.

```APIDOC
Quickstart Guide:

- Upstreet Documentation (Homepage):
  URL: /
  Description: Main entry point for Upstreet AI documentation.

- Setup the SDK:
  URL: /install
  Description: Instructions on how to install and set up the Upstreet AI SDK.

- Create an Agent:
  URL: /create-an-agent
  Description: Step-by-step guide to creating your first AI agent.

- Customize your Agent:
  URL: /customize-your-agent
  Description: Learn how to customize agent behavior and parameters.

- Test your Agent:
  URL: /test-your-agent
  Description: Methods and best practices for testing your AI agents.

- Deploy your Agent:
  URL: /deploy-your-agent
  Description: Guide on deploying your AI agents to production environments.
```

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

### Upstreet AI SDK Getting Started Link

Source: https://docs.upstreet.ai/create-an-agent

Provides a direct link to the installation guide for the Upstreet Agents SDK, encouraging users to get started with the public beta.

```html
<p>The Upstreet Agents SDK is now in public beta 🎉 </p>
<a class="underline font-bold" href="https://docs.upstreet.ai/install">Get started →</a>
```

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

### Upstreet AI LLMs Quickstart Guide

Source: https://docs.upstreet.ai/install

Guides users through the initial steps of setting up the Upstreet AI SDK, creating and customizing agents, testing their functionality, and deploying them.

```mdx
## Upstreet Documentation

### 🚀 Quickstart

- **Setup the SDK**: `/install`
- **Create an Agent**: `/create-an-agent`
- **Customize your Agent**: `/customize-your-agent`
- **Test your Agent**: `/test-your-agent`
- **Deploy your Agent**: `/deploy-your-agent`
```

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

### Upstreet Agents SDK Beta Announcement

Source: https://docs.upstreet.ai/install

Announces the public beta of the Upstreet Agents SDK and provides a link to get started with installation.

```text
The Upstreet Agents SDK is now in public beta 🎉
Get started → https://docs.upstreet.ai/install
```

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

### Discord Agent Setup Guide

Source: https://context7_llms

Instructions for setting up the Upstreet SDK (usdk) for building a Discord Agent. This involves installing NodeJS and the usdk package, as outlined in the 'Setup the SDK' guide.

```markdown
Follow *[Setup the SDK](/install)* to set up NodeJS and `usdk`.
```

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

### SDK Setup and Usage

Source: https://docs.upstreet.ai/install

This section details the initial steps for setting up and using the Upstreet Agents SDK. It covers prerequisites like Node.js installation and how to install the SDK via NPM. It also includes optional verification steps and how to log into the SDK to begin development.

```APIDOC
Prerequisites:
  - Install Node.js

Install from NPM:
  - Command: npm install usdk

Verify Installation (optional):
  - Description: Steps to confirm the SDK is installed correctly.

Log into the SDK:
  - Description: Instructions on authenticating with the SDK to access services.

Related Concepts:
  - What are Agents: /concepts/what-are-agents
  - SDK Architecture: /concepts/usdk/architecture
```

```bash
npm install usdk
```

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

### Quickstart: Creating an Agent

Source: https://docs.upstreet.ai/create-an-agent

This section outlines the quickstart guide for creating an agent, detailing the necessary steps from running the initial command to completing the agent interview and understanding the file structure.

```markdown
# Quickstart: Creating an Agent

## Step 1: Running the command

## Step 2: Complete the Agent Interview

## File Structure

## Editing your Agent

## What's next?
```

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

### Verify USDK Installation

Source: https://docs.upstreet.ai/install

Confirms that the USDK command-line tool has been successfully installed. Running this command will display the currently installed version of the SDK.

```bash
usdk version
```

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

### UI Structure Example

Source: https://docs.upstreet.ai/install

An example of a UI component structure, likely from a frontend framework, defining class names and nested elements for layout and styling.

```html
<div class="flex flex-row flex-wrap items-center justify-between gap-4 empty:hidden">
  <!-- Children elements -->
</div>
```

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

### SDK Installation Link

Source: https://docs.upstreet.ai/concepts/usdk/agent-structure

Provides the URL for getting started with the Upstreet Agents SDK installation.

```html
<a class="underline font-bold" href="https://docs.upstreet.ai/install">Get started →</a>
```

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

### Upstreet AI LLM Getting Started Guide

Source: https://docs.upstreet.ai/concepts/defining-agent-objectives

Guides users through the initial steps of setting up and using the Upstreet AI LLM SDK, from installation to deployment.

```markdown
# Upstreet Documentation

## 🚀 Quickstart

- **Setup the SDK**
- **Create an Agent**
- **Customize your Agent**
- **Test your Agent**
- **Deploy your Agent**

## 📚 API Reference

- **Overview**
- **Components**
- **Hooks**
```

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

### Upstreet AI LLM Quickstart Guide

Source: https://docs.upstreet.ai/examples/informative-agent

Guides users through the initial steps of using Upstreet AI LLMs, including setting up the SDK, creating an agent, customizing it, testing, and deploying.

```APIDOC
APIDOC:
  Getting Started:
    Overview:
      Description: Introduction to Upstreet AI LLMs.
      URL: /
    Install SDK:
      Description: Steps to install the Upstreet AI SDK.
      URL: /install
    Create Agent:
      Description: Guide on creating a new AI agent.
      URL: /create-an-agent
    Customize Agent:
      Description: How to customize agent behavior and properties.
      URL: /customize-your-agent
    Test Agent:
      Description: Methods for testing AI agents.
      URL: /test-your-agent
    Deploy Agent:
      Description: Instructions for deploying AI agents.
      URL: /deploy-your-agent
```

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

### Setup SDK

Source: https://docs.upstreet.ai/examples/discord-agent

Instructions for setting up the NodeJS environment and the usdk. This step involves following a link to install the SDK.

```bash
Follow the guide to set up NodeJS and usdk.
```

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

### Examples

Source: https://docs.upstreet.ai/api/components

Guides and code examples for various agent functionalities, including Hello World, Informative, Stateful, Action, Discord, and OpenAPI agents.

```APIDOC
Example: /examples
Description: Main examples page.
Reference File: examples/index.mdx

Example: /examples/hello-world
Description: Hello World Agent example.
Reference File: examples/hello-world.mdx

Example: /examples/informative-agent
Description: Informative Agent example.
Reference File: examples/informative-agent.mdx

Example: /examples/stateful-agent
Description: Stateful Agent example.
Reference File: examples/stateful-agent.mdx

Example: /examples/action-agent
Description: Action Agent (Personal Assistant) example.
Reference File: examples/action-agent.mdx

Example: /examples/discord-agent
Description: Discord Agent example.
Reference File: examples/discord-agent.mdx

Example: /examples/openapi-agent
Description: OpenAPI Agent example.
Reference File: examples/openapi-agent.mdx
```

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

### Install USDK CLI

Source: https://docs.upstreet.ai/install

Installs the Upstreet AI LLM SDK command-line tool globally on your system. This command uses npm, the Node Package Manager, to fetch and install the package.

```bash
npm install -g usdk
```

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

### Verify SDK Installation

Source: https://docs.upstreet.ai/install

Checks the installed version of the Upstreet Agents SDK. This command helps confirm that the installation was successful and displays the current version number.

```bash
usdk version
```

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

### Install Upstreet Agents SDK

Source: https://docs.upstreet.ai/install

Installs the Upstreet Agents SDK command-line tool globally using npm. This command is essential for using the `usdk` utility on your system.

```bash
npm install -g usdk
```

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

### Upstreet AI LLMs Quickstart Guide

Source: https://docs.upstreet.ai/api/integrations/discord

Guides users through the initial steps of setting up the Upstreet AI LLMs SDK, creating an agent, customizing it, testing, and deploying.

```markdown
## 🚀 Quickstart

### Upstreet Documentation
[Upstreet Documentation](/)

### Setup the SDK
[Setup the SDK](/install)

### Create an Agent
[Create an Agent](/create-an-agent)

### Customize your Agent
[Customize your Agent](/customize-your-agent)

### Test your Agent
[Test your Agent](/test-your-agent)

### Deploy your Agent
[Deploy your Agent](/deploy-your-agent)
```

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

### Run Docs Application

Source: https://github.com/upstreetAI/upstreet-core

Starts the documentation application in development mode. Requires project dependencies to be installed first.

```shell
pnpm run docs dev
```

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

### Basic Agent Setup Example

Source: https://docs.upstreet.ai/customize-your-agent

An example illustrating how to set up a basic agent, likely named 'MyAgent', using the imported components. This showcases a typical integration pattern within a React application.

```javascript
const MyAgent = () => (
  <Agent />
);
```

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

### Upstreet Agents SDK Beta Announcement

Source: https://docs.upstreet.ai/advanced/custom-components/with-use-state

Announces the public beta of the Upstreet Agents SDK and provides a link to get started with installation and setup.

```text
The Upstreet Agents SDK is now in public beta 🎉 
Get started → https://docs.upstreet.ai/install
```

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

### Command-Line Interface Setup

Source: https://docs.upstreet.ai/install

Instructions for accessing and using command-line interfaces on different operating systems. This includes details for macOS, Linux, and Windows.

```bash
macOS: Use the "Terminal" app, located in Applications > Utilities.
Linux: Use the "Terminal" application, usually accessible from the applications menu.
```

```windows-cmd
Windows: Use the "Command Prompt". You can find the Command Prompt by hitting the Windows key (⊞ Win) and searching for the "Command Prompt" application.
```

```powershell
Windows: Important: We do not recommend using PowerShell or ⊞ Win+R on Windows as it often has issues with NodeJS. If you must use PowerShell, you can try out this possible solution.
```

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

### Hello World Agent Example

Source: https://docs.upstreet.ai/examples

Demonstrates the creation of a basic AI agent with a simple personality. This is a foundational example for getting started with the Upstreet AI SDK.

```javascript
self.__next_f.push([1,"2d:[\"$\",\"div\",null,{\"className\":\"flex flex-row gap-3 flex-wrap\",\"children\":[[\"$\",\"$L14\",\"/examples/hello-world\",{\"href\":\"/examples/hello-world\",\"className\":\"no-underline md:max-w-xs w-full group/card\",\"children\":[\"$\",\"$L31\",null,{\"variant\":\"official\",\"title\":\"Hello World Agent\",\"description\":\"Build a simple Agent with a personality.\",\"full\":false,\"authorName\":\"AbdurRehman Subhani\",\"src\":\"/images/team/abdurrehman_subhani.jpeg\",\"thumbnailSrc\":\"/images/example-thumbnails/hello-world.png\",\"authorSubtitle\":\"Official Upstreet Team\"}]}]}]}]])
```

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

### Upstreet Agents SDK Beta Announcement

Source: https://docs.upstreet.ai/test-your-agent

Announces the public beta of the Upstreet Agents SDK and provides a link to get started with installation.

```text
The Upstreet Agents SDK is now in public beta 🎉
Get started → https://docs.upstreet.ai/install
```

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

### Project Setup Commands

Source: https://react.dev/learn/tutorial-tic-tac-toe

Commands to set up a local React development environment. This includes navigating to the project directory, installing necessary dependencies, and starting the local development server.

```shell
cd <directory>
npm install
npm start
```

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

### Example Agent Component (React)

Source: https://docs.upstreet.ai/advanced/custom-components/with-use-state

A basic React component demonstrating the structure of an agent as provided by the Upstreet SDK setup. It serves as a starting point for building custom agents.

```javascript
export default function MyAgent() {
  return (
    <Agent>
    </Agent>
  );
}
```

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

### Trigger Animation with useEffect

Source: https://react.dev/reference/react/useEffect

This React example shows how to trigger an animation using the useEffect hook. It interacts with an external animation library, using a ref to access the DOM node and calling its 'start()' method when the component mounts.

```javascript
// Assuming an external animation library with a FadeInAnimation class
// import { FadeInAnimation } from './animation.js';

// In a React component:
// const animationRef = useRef(null);
// useEffect(() => {
//   if (animationRef.current) {
//     const animation = new FadeInAnimation(animationRef.current);
//     animation.start();
//     return () => {
//       animation.stop();
//     };
//   }
// }, []);
// return <div ref={animationRef}>...</div>;
```

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

### Quickstart: Creating an Agent

Source: https://docs.upstreet.ai/create-an-agent

Follow these steps to set up and create your first Upstreet AI Agent. This involves preparing your project directory and running the initialization command.

```bash
npx create-upstreet-agent@latest
```

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

### GitHub Product Navigation Links

Source: https://github.com/UpstreetAI/usdk-examples/

This snippet lists key GitHub products and their brief descriptions, often linked from navigation menus or landing pages. It highlights AI-powered tools and development services.

```html
<ul>
  <li>
    <a href="https://github.com/features/copilot">
      GitHub Copilot
      <span>Write better code with AI</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/spark">
      GitHub Spark New
      <span>Build and deploy intelligent apps</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/models">
      GitHub Models New
      <span>Manage and compare prompts</span>
    </a>
  </li>
  <li>
    <a href="https://github.security/advanced-security">
      GitHub Advanced Security
      <span>Find and fix vulnerabilities</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/actions">
      Actions
      <span>Automate any workflow</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/codespaces">
      Codespaces
      <span>Instant dev environments</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/issues">
      Issues
      <span>Plan and track work</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/code-review">
      Code Review
      <span>Manage code changes</span>
    </a>
  </li>
  <li>
    <a href="https://github.com/features/discussions">
      Discussions
      <span>Collaborate outside of code</span>
    </a>
  </li>
</ul>
```

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

### Set Up USDK Package Locally

Source: https://github.com/upstreetAI/upstreet-core

Steps to install the `usdk` package locally within the project's `packages/usdk` directory. This allows for development and testing of local changes to the SDK, which will automatically update the globally installed version.

```bash
cd packages/usdk
pnpm i
pnpm i -g .
usdk --version
```

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

### Install Project Dependencies

Source: https://github.com/upstreetAI/upstreet-core

Installs all project dependencies using pnpm. This is the initial step before running any applications.

```shell
pnpm install
```

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

### Install Browser Runtime

Source: https://context7_llms

Installs the react-agents-browser package for running agents directly in a web browser. Requires a React project setup.

```bash
npm install react-agents-browser
```

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

### Log into the Upstreet SDK

Source: https://docs.upstreet.ai/install

To use certain Upstreet SDK features, you need to be logged in. This process involves running a command and authenticating via a browser. It is recommended to specify a fixed version for consistency when running commands.

```bash
usdk login
```

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

### Log into the SDK

Source: https://docs.upstreet.ai/install

Initiates the login process for the Upstreet Agents SDK. This command opens a browser for authentication, which is required for certain SDK features.

```bash
usdk login
```

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

### Project Examples Documentation

Source: https://docs.upstreet.ai/pricing

Documentation for various project examples, demonstrating different agent functionalities such as Hello World, Informative Agents, Stateful Agents, Action Agents, Discord Agents, and OpenAPI Agents.

```APIDOC
Project Examples:
  index:
    url: /examples
    description: Main entry point for project examples.
    $ref: examples/index.mdx
  helloWorldAgent:
    url: /examples/hello-world
    description: Example of a basic 'Hello World' agent.
    $ref: examples/hello-world.mdx
  informativeAgent:
    url: /examples/informative-agent
    description: Example of an agent providing information.
    $ref: examples/informative-agent.mdx
  statefulAgent:
    url: /examples/stateful-agent
    description: Example of an agent maintaining state.
    $ref: examples/stateful-agent.mdx
  actionAgent:
    url: /examples/action-agent
    description: Example of an agent performing actions (Personal Assistant).
    $ref: examples/action-agent.mdx
  discordAgent:
    url: /examples/discord-agent
    description: Example of an agent integrated with Discord.
    $ref: examples/discord-agent.mdx
  openapiAgent:
    url: /examples/openapi-agent
    description: Example of an agent interacting with OpenAPI specifications.
    $ref: examples/openapi-agent.mdx
```

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

### Verify Node.js Installation

Source: https://docs.upstreet.ai/install

Check the installed version of Node.js on your system. This command is crucial for ensuring compatibility with Node.js-dependent tools like usdk.

```Shell
node -v
```

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

### Edit on GitHub Link

Source: https://docs.upstreet.ai/install

Provides a link to edit the current documentation page on GitHub. It specifies the owner, repository, and the path to the file.

```json
{
  "owner": "UpstreetAI",
  "path": "apps/docs/content/docs/(getting-started)/install.mdx",
  "repo": "upstreet-core"
}
```

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

### Install Zod Canary Version

Source: https://zod.dev/

Instructions for installing the canary version of Zod across various package managers. This ensures you get the latest development builds.

```bash
npm install zod@canary # npm
deno add npm:zod@canary # deno
yarn add zod@canary # yarn
bun add zod@canary # bun
pnpm add zod@canary # pnpm
```

```typescript
// Example usage in TypeScript
import { z } from 'zod';

const schema = z.object({
  name: z.string(),
  age: z.number().optional(),
});

console.log(schema.parse({ name: 'Alice', age: 30 }));
console.log(schema.parse({ name: 'Bob' }));

```

```typescript
// Example usage in TypeScript with canary features
// Note: Specific canary features might require different import paths or syntax
// depending on the Zod version and its experimental features.
// This is a placeholder for potential canary-specific code.

// import { z } from 'zod/canary'; // Hypothetical import for canary features

// const advancedSchema = z.object({
//   id: z.string().uuid(),
//   createdAt: z.date().transform(date => date.toISOString()),
// });

// console.log(advancedSchema.parse({ id: '123e4567-e89b-12d3-a456-426614174000', createdAt: new Date() }));

```

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

### Setup USDK Step

Source: https://docs.upstreet.ai/examples/informative-agent

Details the first step in the setup process, which involves the USDK. Includes a code block for the USDK.

```markdown
"Step 1: Setup "
["$","code",null,"usdk"]
"#step-1-setup-usdk"
```

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

### Verify NPM Installation

Source: https://docs.upstreet.ai/install

Check the installed version of NPM (Node Package Manager). NPM is bundled with Node.js and is used for managing JavaScript project dependencies.

```Shell
npm -v
```

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

### Navigation Links

Source: https://docs.upstreet.ai/install

Defines navigation links for different Upstreet AI products, including Scillia, Platform, and the USDK.

```json
{
  "title": "Scillia",
  "description": "Your personal assistant",
  "url": "/scillia",
  "icon": [
    "$",
    "$L12",
    null,
    {
      "alt": "product logo",
      "src": "/images/general/Scillia_Logo.png",
      "width": 30,
      "height": 30,
      "className": "rounded-md"
    }
  ]
},
{
  "title": "Platform",
  "description": "The Agent Platform",
  "url": "/platform",
  "icon": [
    "$",
    "$L12",
    null,
    {
      "alt": "product logo",
      "src": "/images/general/Platform_Logo.png",
      "width": 30,
      "height": 30,
      "className": "rounded-md"
    }
  ]
},
{
  "title": "USDK",
  "description": "Upstreet Agents SDK",
  "url": "",
  "icon": [
    "$",
    "$L12",
    null,
    {
      "alt": "product logo",
      "src": "/images/general/USDK_Logo.png",
      "width": 30,
      "height": 30,
      "className": "rounded-md"
    }
  ],
  "props": {
    "href": "/"
  }
}
```

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

### Discord Bot Setup Guidance

Source: https://docs.upstreet.ai/examples/discord-agent

This section provides information and guidance related to setting up a Discord bot, clarifying that the tutorial itself does not cover token acquisition but suggests an alternative prompt for assistance.

```en
This tutorial will not cover how to obtain Discord tokens. For more information on how to build Discord bots, you can refer to the Discord Component's documentation. You can also request our agent to guide you through obtaining tokens. Simply use the prompt below, and it will provide a step-by-step process.
```