%sveltekit.body%
12 |
13 |
14 |
--------------------------------------------------------------------------------
/dashboard/Dockerfile:
--------------------------------------------------------------------------------
1 | FROM node:18-alpine AS builder
2 | WORKDIR /dashboard
3 | COPY package*.json .
4 | RUN npm ci
5 | COPY . .
6 | RUN npm run build
7 | RUN npm prune --production
8 |
9 | FROM node:18-alpine AS production
10 | WORKDIR /dashboard
11 | COPY --from=builder /dashboard/build ./build
12 | COPY --from=builder /dashboard/node_modules ./node_modules
13 | COPY --from=builder /dashboard/package.json ./package.json
14 | EXPOSE 2515
15 | ENV PORT=2515
16 | ENV NODE_ENV=production
17 | CMD ["node", "build"]
18 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/feature_request.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: 🛠️ Feature Request
3 | about: Request a new feature or an improvement to an existing feature.
4 | title: "[FEAT] "
5 | labels: enhancement
6 | ---
7 |
8 | ### Feature Description
9 |
10 |
11 |
12 | ### Potential Solution
13 |
14 |
15 |
16 | ### Additional Context
17 |
18 |
19 |
--------------------------------------------------------------------------------
/dashboard/src/lib/types.ts:
--------------------------------------------------------------------------------
1 | export type Connection = {
2 | id: string
3 | name: string
4 | address: string
5 | }
6 |
7 | export type Alert = {
8 | id: string
9 | type: "success" | "error"
10 | message: string
11 | }
12 |
13 | export type ApprovalRequest = {
14 | id: string
15 | name: string
16 | parameters: string
17 | context: string
18 | }
19 |
20 | export type ApprovalResponse = {
21 | id: string
22 | approved: boolean
23 | parameters: string
24 | approver: Approver
25 | }
26 |
27 | export type Approver = {
28 | name: string
29 | email: string
30 | }
31 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/cards/alert.svelte:
--------------------------------------------------------------------------------
1 |
6 |
7 |
8 |
10 |
11 |
25 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/utils/wordmark.svelte:
--------------------------------------------------------------------------------
1 |
18 |
19 | {alert.message}
9 |
20 | 
21 | Phantasm
22 |
23 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/buttons/action.svelte:
--------------------------------------------------------------------------------
1 |
6 |
7 |
11 |
12 |
24 |
--------------------------------------------------------------------------------
/Cargo.toml:
--------------------------------------------------------------------------------
1 | [package]
2 | name = "phantasm"
3 | version = "0.1.2"
4 | edition = "2021"
5 |
6 | [dependencies]
7 | tokio = { version = "1.40.0", features = ["macros", "rt-multi-thread"] }
8 | tokio-tungstenite = "0.24.0"
9 | futures = "0.3.31"
10 | clap = "4.5.20"
11 |
12 | # gRPC
13 | tonic = "0.12.3"
14 | prost = "0.13.3"
15 |
16 | # Tracing
17 | tracing = "0.1.40"
18 | tracing-subscriber = "0.3.18"
19 |
20 | # Serialization
21 | serde = { version = "1.0.210", features = ["derive"] }
22 | serde_json = "1.0.128"
23 |
24 | # Utils
25 | uuid = { version = "1.10.0", features = ["v4", "serde", "fast-rng"] }
26 | dotenv = "0.15.0"
27 |
28 | [build-dependencies]
29 | tonic-build = "0.12"
30 |
--------------------------------------------------------------------------------
/.github/workflows/dashboard-ci.yml:
--------------------------------------------------------------------------------
1 | name: Quality Check Dashboard
2 |
3 | on:
4 | workflow_dispatch:
5 |
6 | pull_request:
7 | paths:
8 | - "dashboard/**"
9 |
10 | push:
11 | branches:
12 | - main
13 | paths:
14 | - "dashboard/**"
15 |
16 | jobs:
17 | ci:
18 | name: Check Code Quality
19 | runs-on: ubuntu-latest
20 | steps:
21 | - name: Checkout Code
22 | uses: actions/checkout@v4
23 |
24 | - name: Install Dependencies
25 | run: |
26 | cd dashboard
27 | npm install
28 |
29 | - name: Run Linting & Formatting Check
30 | run: |
31 | cd dashboard
32 | npm run lint
33 |
--------------------------------------------------------------------------------
/.github/ISSUE_TEMPLATE/bug_report.md:
--------------------------------------------------------------------------------
1 | ---
2 | name: 🐞 Report Bug
3 | about: Report an unexpected behavior or a malfunctioning feature.
4 | title: "[BUG] "
5 | labels: bug
6 | ---
7 |
8 | ### Bug Description
9 |
10 |
11 |
12 | ### Steps to Reproduce
13 |
14 |
15 |
16 | 1. Import the library in ...
17 | 2. Initialize the object with ...
18 | 3. Call the function ...
19 |
20 | ### Expected Behavior
21 |
22 |
23 |
24 | ### Additional Context
25 |
26 |
27 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/buttons/basic.svelte:
--------------------------------------------------------------------------------
1 |
13 |
14 |
15 |
16 |
23 |
--------------------------------------------------------------------------------
/Makefile:
--------------------------------------------------------------------------------
1 | # Colors for better visibility in output
2 | GREEN := \033[0;32m
3 | BOLD := \033[1m
4 | RESET := \033[0m
5 |
6 | .PHONY: all
7 | all:
8 | @echo "Phantasm Makefile for Developers"
9 | @echo ""
10 | @echo "$(BOLD)Usage$(RESET): make
21 | Phantasm
22 |
8 | "]
9 | classifiers = [
10 | "Intended Audience :: Developers",
11 | "Intended Audience :: System Administrators",
12 | "Topic :: System :: Monitoring",
13 | "Topic :: Scientific/Engineering :: Artificial Intelligence",
14 | "Topic :: Scientific/Engineering :: Human Machine Interfaces",
15 | ]
16 |
17 | [tool.poetry.urls]
18 | "Issues" = "https://github.com/phantasmlabs/phantasm/issues"
19 |
20 | [tool.poetry.dependencies]
21 | python = "^3.10"
22 | black = "^24.10.0"
23 | grpcio = "^1.67.0"
24 | grpcio-tools = "^1.67.0"
25 |
26 | [build-system]
27 | requires = ["poetry-core"]
28 | build-backend = "poetry.core.masonry.api"
29 |
30 | [tool.black]
31 | line-length = 80
32 |
33 | [tool.poetry.scripts]
34 | test_get_approval = "phantasmpy.client:test_get_approval"
35 |
--------------------------------------------------------------------------------
/dashboard/src/app.css:
--------------------------------------------------------------------------------
1 | @tailwind base;
2 | @tailwind components;
3 | @tailwind utilities;
4 |
5 | .cm-editor.cm-focused {
6 | outline: 2px solid transparent;
7 | outline-offset: 2px;
8 | }
9 |
10 | .cm-editor.cm-content {
11 | font-family: "Inconsolata", monospace;
12 | }
13 |
14 | @layer base {
15 | body {
16 | @apply bg-white text-gray-900;
17 | @apply scroll-smooth leading-normal tracking-normal;
18 | font-family: "Cabin", sans-serif;
19 | font-size: 16px;
20 | }
21 |
22 | h1,
23 | h2,
24 | h3 {
25 | @apply font-bold;
26 | }
27 |
28 | h1 {
29 | @apply text-4xl;
30 | }
31 |
32 | h2 {
33 | @apply text-3xl;
34 | }
35 |
36 | h3 {
37 | @apply text-2xl;
38 | }
39 |
40 | small {
41 | @apply text-sm text-gray-500;
42 | }
43 |
44 | code {
45 | font-family: "Inconsolata", monospace;
46 | }
47 | }
48 |
49 | @layer components {
50 | .control-button {
51 | @apply p-1 rounded text-gray-500;
52 | @apply transition-colors duration-300;
53 | }
54 |
55 | .control-button:hover {
56 | @apply bg-black bg-opacity-5;
57 | }
58 | }
59 |
--------------------------------------------------------------------------------
/.github/workflows/server-ci.yml:
--------------------------------------------------------------------------------
1 | name: Quality Check Server
2 |
3 | on:
4 | workflow_dispatch:
5 |
6 | pull_request:
7 | paths-ignore:
8 | - "docs/**"
9 | - "clients/**"
10 | - "dashboard/**"
11 |
12 | push:
13 | branches:
14 | - main
15 | paths-ignore:
16 | - "docs/**"
17 | - "clients/**"
18 | - "dashboard/**"
19 |
20 | jobs:
21 | ci:
22 | name: Test & Check Code Quality
23 | runs-on: ubuntu-latest
24 | steps:
25 | - name: Checkout Code
26 | uses: actions/checkout@v4
27 |
28 | - name: Install Rust Toolchain
29 | uses: dtolnay/rust-toolchain@stable
30 | with:
31 | components: rustfmt, clippy
32 |
33 | - name: Install Protobuf Compiler
34 | run: |
35 | sudo apt update && sudo apt upgrade -y
36 | sudo apt install -y protobuf-compiler libprotobuf-dev
37 |
38 | - name: Run Formatter
39 | run: cargo fmt -- --check
40 |
41 | - name: Run Linter
42 | run: cargo clippy -- -D warnings
43 |
44 | - name: Run Tests
45 | run: cargo test -- --test-threads 1
46 |
--------------------------------------------------------------------------------
/clients/LICENSE:
--------------------------------------------------------------------------------
1 | MIT License
2 |
3 | Copyright (c) 2024 Phantasm
4 |
5 | Permission is hereby granted, free of charge, to any person obtaining a copy
6 | of this software and associated documentation files (the "Software"), to deal
7 | in the Software without restriction, including without limitation the rights
8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9 | copies of the Software, and to permit persons to whom the Software is
10 | furnished to do so, subject to the following conditions:
11 |
12 | The above copyright notice and this permission notice shall be included in all
13 | copies or substantial portions of the Software.
14 |
15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21 | SOFTWARE.
22 |
--------------------------------------------------------------------------------
/.github/workflows/dashboard-cd.yml:
--------------------------------------------------------------------------------
1 | name: Deploy Dashboard
2 |
3 | on:
4 | workflow_dispatch:
5 | release:
6 | types: [published]
7 |
8 | permissions:
9 | contents: read
10 | packages: write
11 |
12 | env:
13 | NAME: ghcr.io/phantasmlabs/phantasm/dashboard
14 |
15 | jobs:
16 | publish-image:
17 | environment: Dashboard
18 | name: Publish Docker Image
19 | runs-on: ubuntu-latest
20 | steps:
21 | - name: Checkout Code
22 | uses: actions/checkout@v4
23 |
24 | - name: Get Package Version
25 | run: |
26 | cd dashboard
27 | VERSION=$(npm pkg get version | tr -d '\"')
28 | echo "VERSION=$VERSION" >> $GITHUB_ENV
29 |
30 | - name: Log in to GitHub Container Registry
31 | run: echo $PASSWORD | docker login ghcr.io -u $USER --password-stdin
32 | env:
33 | USER: ${{ github.actor }}
34 | PASSWORD: ${{ secrets.GITHUB_TOKEN }}
35 |
36 | - name: Set up Docker Buildx
37 | uses: docker/setup-buildx-action@v3
38 |
39 | - name: Build Docker Image
40 | run: docker build -t $NAME:$VERSION -t $NAME:latest ./dashboard
41 |
42 | - name: Push Docker Image to GHCR
43 | run: |
44 | docker push $NAME:$VERSION
45 | docker push $NAME:latest
46 |
--------------------------------------------------------------------------------
/protos/receiver.proto:
--------------------------------------------------------------------------------
1 | // NOTE: If you update this file, you must also update the corresponding
2 | // client libraries in the clients directory.
3 |
4 | syntax = "proto3";
5 | package receiver;
6 |
7 | import "google/protobuf/empty.proto";
8 |
9 | // Receiver service definition.
10 | //
11 | // The receiver service is used to receive an approval requests from the
12 | // client SDK. This requests can then be relayed to the coordinator service
13 | // to be dispatched to the appropriate approvers.
14 | service Receiver {
15 | // Check if the receiver service is running.
16 | rpc Heartbeat(google.protobuf.Empty) returns (HeartbeatResponse) {}
17 |
18 | // Create a new approval request for the approvers to review.
19 | rpc GetApproval(GetApprovalRequest) returns (GetApprovalResponse) {}
20 | }
21 |
22 | // Below are the messages used in the client-reciever communication.
23 | // These types are often translated into the language-specific types. If you
24 | // change these, you may need to update these translated types in the clients.
25 |
26 | message HeartbeatResponse {
27 | string version = 1;
28 | }
29 |
30 | message GetApprovalRequest {
31 | string name = 1;
32 | string parameters = 2;
33 | string context = 3;
34 | }
35 |
36 | message GetApprovalResponse {
37 | bool approved = 1;
38 | string parameters = 2;
39 | }
40 |
--------------------------------------------------------------------------------
/.github/workflows/docs-cd.yml:
--------------------------------------------------------------------------------
1 | name: Deploy Documentation
2 |
3 | on:
4 | workflow_dispatch:
5 |
6 | push:
7 | branches:
8 | - main
9 | paths:
10 | - "docs/**"
11 | - "mkdocs.yml"
12 |
13 | permissions:
14 | id-token: write
15 | pages: write
16 | contents: write
17 |
18 | jobs:
19 | build-docs:
20 | name: Build Documentation
21 | runs-on: ubuntu-latest
22 | steps:
23 | - name: Checkout Code
24 | uses: actions/checkout@v4
25 |
26 | - name: Install Python
27 | uses: actions/setup-python@v5
28 | with:
29 | python-version: 3.x
30 |
31 | - name: Install Dependencies
32 | run: pip install -r requirements.txt
33 |
34 | - name: Push Build Artifact
35 | run: |
36 | mkdocs gh-deploy --force --message "cd: deploy docs from {sha}"
37 |
38 | publish-docs:
39 | environment: Docs
40 | name: Publish Documentation
41 | runs-on: ubuntu-latest
42 | needs: build-docs
43 | steps:
44 | - name: Checkout Code
45 | uses: actions/checkout@v4
46 | with:
47 | ref: gh-pages
48 |
49 | - name: Setup Pages
50 | uses: actions/configure-pages@v5
51 |
52 | - name: Upload Artifact
53 | uses: actions/upload-pages-artifact@v3
54 | with:
55 | path: "."
56 |
57 | - name: Deploy to GitHub Pages
58 | uses: actions/deploy-pages@v4
59 |
--------------------------------------------------------------------------------
/dashboard/package.json:
--------------------------------------------------------------------------------
1 | {
2 | "name": "@phantasmlabs/dashboard",
3 | "version": "0.1.2",
4 | "type": "module",
5 | "private": true,
6 | "scripts": {
7 | "dev": "vite dev",
8 | "build": "vite build",
9 | "preview": "vite preview",
10 | "lint": "prettier --check . && eslint .",
11 | "format": "prettier --write ."
12 | },
13 | "dependencies": {
14 | "@codemirror/commands": "^6.7.1",
15 | "@codemirror/lang-javascript": "^6.2.2",
16 | "@codemirror/state": "^6.4.1",
17 | "@codemirror/view": "^6.34.1",
18 | "@fontsource/cabin": "^5.1.0",
19 | "@fontsource/inconsolata": "^5.1.0",
20 | "carbon-icons-svelte": "^12.12.0"
21 | },
22 | "devDependencies": {
23 | "@sveltejs/adapter-node": "^5.2.9",
24 | "@sveltejs/kit": "^2.0.0",
25 | "@sveltejs/vite-plugin-svelte": "^3.0.0",
26 | "@types/eslint": "^9.6.0",
27 | "@types/eslint__js": "^8.42.3",
28 | "@types/eslint-config-prettier": "^6.11.3",
29 | "autoprefixer": "^10.4.20",
30 | "eslint": "^9.0.0",
31 | "eslint-config-prettier": "^9.1.0",
32 | "eslint-plugin-svelte": "^2.36.0",
33 | "globals": "^15.0.0",
34 | "postcss": "^8.4.47",
35 | "prettier": "^3.3.3",
36 | "prettier-plugin-svelte": "^3.2.7",
37 | "svelte": "^4.2.7",
38 | "svelte-check": "^4.0.0",
39 | "tailwindcss": "^3.4.14",
40 | "typescript": "^5.0.0",
41 | "typescript-eslint": "^8.0.0",
42 | "vite": "^5.0.3"
43 | }
44 | }
45 |
--------------------------------------------------------------------------------
/.github/SECURITY.md:
--------------------------------------------------------------------------------
1 | # Security Policy
2 |
3 | **Please do not report security vulnerabilities through public GitHub issues.**
4 |
5 | Thank you for taking the time to report a security issue. We are trying our best
6 | to make this project safe for everyone. We appreciate your efforts to disclose
7 | the issue responsibly and will make every effort to acknowledge your
8 | contributions.
9 |
10 | ## Reporting a Vulnerability
11 |
12 | If you believe you have found a security vulnerability, please send an email to
13 | edwin@phantasmlabs.com. Please include as many details as possible. These may
14 | include:
15 |
16 | - A detailed description of the issue.
17 | - Steps to reproduce the problem.
18 | - The potential impact of the issue.
19 |
20 | ## Security Update Process
21 |
22 | Once a vulnerability is reported, we will follow this process:
23 |
24 | 1. **Review**: We will review the report to confirm the vulnerability and assess
25 | its impact on the project.
26 | 2. **Fix and Patch**: We will work to develop a fix, and create a patch or
27 | release that addresses the issue.
28 | 3. **Advisory**: We will issue an advisory with details about the vulnerability,
29 | including the instructions for mitigating the issue.
30 |
31 | ## Acknowledgments
32 |
33 | We greatly appreciate security researchers and users who report vulnerabilities
34 | responsibly. If desired, we will publicly acknowledge your contributions in the
35 | security advisory unless you prefer to remain anonymous.
36 |
--------------------------------------------------------------------------------
/.github/workflows/server-cd.yml:
--------------------------------------------------------------------------------
1 | name: Deploy Server
2 |
3 | on:
4 | workflow_dispatch:
5 | release:
6 | types: [published]
7 |
8 | permissions:
9 | contents: read
10 | packages: write
11 |
12 | env:
13 | NAME: ghcr.io/phantasmlabs/phantasm/server
14 |
15 | jobs:
16 | publish-image:
17 | environment: Server
18 | name: Publish Docker Image
19 | runs-on: ubuntu-latest
20 | steps:
21 | - name: Checkout Code
22 | uses: actions/checkout@v4
23 |
24 | - name: Install Rust Toolchain
25 | uses: dtolnay/rust-toolchain@stable
26 |
27 | - name: Install Protobuf Compiler
28 | run: |
29 | sudo apt update && sudo apt upgrade -y
30 | sudo apt install -y protobuf-compiler libprotobuf-dev
31 |
32 | - name: Get Package Version
33 | run: |
34 | VERSION=$(cargo run -- -V | awk '{print $2}')
35 | echo "VERSION=$VERSION" >> $GITHUB_ENV
36 |
37 | - name: Log in to GitHub Container Registry
38 | run: echo $PASSWORD | docker login ghcr.io -u $USER --password-stdin
39 | env:
40 | USER: ${{ github.actor }}
41 | PASSWORD: ${{ secrets.GITHUB_TOKEN }}
42 |
43 | - name: Set up Docker Buildx
44 | uses: docker/setup-buildx-action@v3
45 |
46 | - name: Build Docker Image
47 | run: docker build -t $NAME:$VERSION -t $NAME:latest .
48 |
49 | - name: Push Docker Image to GHCR
50 | run: |
51 | docker push $NAME:$VERSION
52 | docker push $NAME:latest
53 |
--------------------------------------------------------------------------------
/mkdocs.yml:
--------------------------------------------------------------------------------
1 | site_name: Phantasm
2 | repo_name: phantasmlabs/phantasm
3 | repo_url: https://github.com/phantasmlabs/phantasm
4 |
5 | theme:
6 | name: material
7 | logo: assets/favicon64.png
8 | favicon: assets/favicon64.png
9 |
10 | icon:
11 | repo: fontawesome/brands/github
12 |
13 | palette:
14 | - media: "(prefers-color-scheme: light)"
15 | scheme: default
16 | primary: black
17 | toggle:
18 | name: Light Mode
19 | icon: material/brightness-7
20 |
21 | - media: "(prefers-color-scheme: dark)"
22 | scheme: slate
23 | primary: black
24 | toggle:
25 | name: Dark Mode
26 | icon: material/brightness-4
27 |
28 | font:
29 | text: Cabin
30 | code: Inconsolata
31 |
32 | features:
33 | - header.autohide
34 | - navigation.tabs
35 | - navigation.tabs.sticky
36 | - navigation.expand
37 | - navigation.footer
38 | - content.code.copy
39 |
40 | copyright: Copyright © 2024 Phantasm Labs
41 |
42 | extra:
43 | generator: false
44 |
45 | # TODO: Add more social links
46 | social:
47 | - icon: fontawesome/brands/discord
48 | link: https://discord.gg/dgevsYhh7P
49 |
50 | extra_css:
51 | - styles.css
52 |
53 | nav:
54 | - Documentation:
55 | - Introduction: index.md
56 | - Configuration: docs/configuration.md
57 | - API Reference: docs/reference.md
58 |
59 | markdown_extensions:
60 | - admonition
61 | - attr_list
62 | - md_in_html
63 | - pymdownx.details
64 | - pymdownx.inlinehilite
65 | - pymdownx.snippets
66 | - pymdownx.superfences
67 |
68 | - pymdownx.tabbed:
69 | alternate_style: true
70 |
71 | - toc:
72 | permalink: "#"
73 |
--------------------------------------------------------------------------------
/docs/docs/reference.md:
--------------------------------------------------------------------------------
1 | # API Reference
2 |
3 | Phantasm offers a simple gRPC API for the client to interact with the server,
4 | specifically the _Receiver Server_. There is only one core API method that you
5 | need to understand and that is the get approval method.
6 |
7 | ## GetApproval
8 |
9 | This is the core method that you will integrate into your AI agent to obtain
10 | approval from the approvers before executing a tool. This is a blocking call, so
11 | if possible, you may want to run it in a separate thread or process.
12 |
13 | One of Phantasm's most distinctive features is its ability to pass parameters
14 | back and forth. This allows the approvers to review the parameters that the AI
15 | agent intends to use and either approve or deny the request based on them. The
16 | approvers can also modify the parameters before granting approval.
17 |
18 | Ideally, the AI agent should use the parameters returned by the approvers as the
19 | final parameters for executing the tool, rather than the original parameters.
20 | This ensures that the AI agent executes the tool accurately.
21 |
22 | ### Request
23 |
24 | ```proto
25 | message GetApprovalRequest {
26 | string name = 1;
27 | string parameters = 2;
28 | string context = 3;
29 | }
30 | ```
31 |
32 | - name: Name of the function the AI agent wants to execute.
33 | - parameters: Parameters to pass to the function.
34 | - context: Additional context to pass to the approvers.
35 |
36 | ### Response
37 |
38 | ```proto
39 | message GetApprovalResponse {
40 | bool approved = 1;
41 | string parameters = 2;
42 | }
43 | ```
44 |
45 | - approved: Boolean indicating if the request was approved.
46 | - parameters: Parameters to pass to the function if approved.
47 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/cards/connection.svelte:
--------------------------------------------------------------------------------
1 |
11 |
12 |
31 |
34 |
42 |
43 |
44 |
45 |
72 |
73 |
80 |
--------------------------------------------------------------------------------
/clients/python/README.md:
--------------------------------------------------------------------------------
1 | [][github]
2 | [][discord]
3 | [][license]
4 |
5 | [discord]: https://discord.gg/dgevsYhh7P
6 | [github]: https://github.com/phantasmlabs/phantasm
7 | [license]: https://github.com/phantasmlabs/phantasm/blob/main/LICENSE
8 |
9 | 
10 |
11 | This client library allows you to interact with Phantasm's receiver server from
12 | your Python codebase. It provides a simple and easy-to-use interface complete
13 | with type hints and documentation. Here's a quick example to get you started
14 | adding an approval workflow to your function:
15 |
16 | ```py
17 | from phantasmpy import Phantasm
18 | phantasm = Phantasm()
19 |
20 | # Replace with your own function.
21 | @phantasm.require_approval()
22 | def schedule_meeting(...):
23 | pass
24 |
25 | schedule_meeting(...)
26 | ```
27 |
28 | ## Advanced Usage With LangChain
29 |
30 | In real-world applications, you may want to use Phantasm with LangChain to
31 | utilize the full power of LangChain's features. For the sake of simplicity, we
32 | will be using OpenAI's GPT model as our language model. Here's how you can build
33 | a tool-powered AI agent with human-in-the-loop capabilities:
34 |
35 | Requirements:
36 |
37 | ```bash
38 | pip install langchain langchain-openai phantasmpy
39 | ```
40 |
41 | ```py
42 | import os
43 | from langchain_core.tools import tool
44 | from langchain_core.messages import AIMessage
45 | from langchain_openai import ChatOpenAI
46 | from phantasmpy import Phantasm
47 |
48 | os.environ["OPENAI_API_KEY"] = "xxx"
49 | llm = ChatOpenAI(model="gpt-4o-mini")
50 |
51 | @tool
52 | def publish_blog(topic: str):
53 | # Add code to draft and publish the blog post.
54 | print(f"A blog post ({topic}) is published.")
55 |
56 | @tool
57 | def send_email(to: str, subject: str, body: str):
58 | # Add code to send an email using an email API.
59 | print(f"An email is sent to {to}.")
60 |
61 | tools = [publish_blog, send_email]
62 | llm_with_tools = llm.bind_tools(tools)
63 | phantasm = Phantasm()
64 |
65 | def call_tools(message: AIMessage):
66 | tool_map = {tool.name: tool for tool in tools}
67 | for tool_call in message.tool_calls:
68 | name, args = tool_call["name"], tool_call["args"]
69 | response = phantasm.get_approval(name=name, parameters=args)
70 |
71 | if response.approved:
72 | tool_map[name].invoke(response.parameters)
73 | else:
74 | print(f"Tool call {name} is rejected.")
75 |
76 | chain = llm_with_tools | call_tools
77 | chain.invoke("Remind elon@x.com about the Monday meeting at 9AM")
78 | ```
79 |
--------------------------------------------------------------------------------
/.github/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Phantasm Change Logs
2 |
3 | This document lists the changes to Phantasm with each release ordered by the
4 | latest release first. Since Phantasm project consists of multiple independent
5 | projects (e.g., server, dashboard, client libraries), the version of the release
6 | will use the date of the release in the format of **YYYY.MM.DD**.
7 |
8 | To stay consistent with each release, when creating a new release on GitHub, we
9 | use the version format above as the tag name and the release title. The release
10 | notes should be added to the release description in the following format:
11 |
12 | ```md
13 | Release Note Content
14 |
15 | ### Contributors
16 |
17 | - @username
18 | - @username
19 |
20 | ### Full Changelog
21 |
22 | GitHub Generated Changelog URL
23 | ```
24 |
25 |
26 |
27 | ### 2024.11.19
28 |
29 | This release includes the following changes:
30 |
31 | - Added client to receiver authentication.
32 | - Include approver details in the response from the dashboard.
33 | - Improved dashboard layout with a sidebar.
34 |
35 | Authentication is disabled by default. To enable authentication, set the
36 | `PHANTASM_SECRET` environment variable in the server component before starting
37 | the server. The client will need to provide the secret when instantiating the
38 | client class to be able to send approval requests correctly.
39 |
40 | Approval response from the dashboard to the coordinator server now includes the
41 | approver details such as the name and email address. This information can be
42 | used to identify the approver who made the decision and enrich the audit logs.
43 |
44 | ### 2024.11.05
45 |
46 | This release includes the following changes:
47 |
48 | - Added context parameter to the approval request Protobuf message.
49 | - Added a dedicated documentation website for Phantasm using MkDocs.
50 | - Added initial unit tests for the server component.
51 | - Fixed spelling error in the approval request card in the dashboard.
52 |
53 | Documentation: [docs.phantasmlabs.com](https://docs.phantasmlabs.com)
54 |
55 | ### 2024.10.29
56 |
57 | This is the initial release of Phantasm which includes 3 components: Server,
58 | Dashboard, and Python Client. The server and dashboard are available as Docker
59 | images via GitHub Container Registry. The Python client is available on PyPI.
60 |
61 | These are the features available in this release:
62 |
63 | - Client can send approval requests to the server via gRPC.
64 | - Server can relay the approval requests to the dashboard via WebSocket.
65 | - Dashboard can displays the approval requests to the approvers.
66 | - Dashboard can send back an approval response to the server via WebSocket.
67 | - Server can send the decision back to the client via gRPC.
68 |
--------------------------------------------------------------------------------
/src/types.rs:
--------------------------------------------------------------------------------
1 | use crate::protos;
2 | use serde::{Deserialize, Serialize};
3 | use std::fmt;
4 | use tokio::sync::mpsc::UnboundedSender;
5 | use tokio_tungstenite::tungstenite::Message;
6 | use uuid::Uuid;
7 |
8 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
9 | pub struct ConnectionID(Uuid);
10 |
11 | impl ConnectionID {
12 | pub fn new() -> Self {
13 | Self(Uuid::new_v4())
14 | }
15 | }
16 |
17 | #[derive(Debug, Clone)]
18 | pub struct Connection {
19 | pub sender: UnboundedSender,
20 | pub load: usize,
21 | }
22 |
23 | impl Connection {
24 | pub fn new(sender: UnboundedSender) -> Self {
25 | Self { sender, load: 0 }
26 | }
27 | }
28 |
29 | #[derive(Debug, Clone, Copy, PartialEq, Eq, Hash)]
30 | #[derive(Serialize, Deserialize)]
31 | pub struct ApprovalID(Uuid);
32 |
33 | impl ApprovalID {
34 | pub fn new() -> Self {
35 | Self(Uuid::new_v4())
36 | }
37 | }
38 |
39 | impl fmt::Display for ApprovalID {
40 | fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
41 | write!(f, "{}", self.0)
42 | }
43 | }
44 |
45 | // The types below are used in dashboard-coordinator communication.
46 | // They are serialized into JSON strings before being sent as WebSocket
47 | // messages. If you change these types, make sure to update the types in
48 | // the dashboard as well.
49 |
50 | #[derive(Debug, Clone, Serialize, Deserialize)]
51 | pub struct ApprovalRequest {
52 | pub id: ApprovalID,
53 | pub name: String,
54 | pub parameters: String,
55 | pub context: String,
56 | }
57 |
58 | impl ApprovalRequest {
59 | pub fn sanitize_context(context: impl Into) -> String {
60 | let context: String = context.into();
61 | if context.is_empty() {
62 | return context;
63 | }
64 |
65 | let context = context.trim();
66 | let lines: Vec<&str> = context.lines().map(str::trim).collect();
67 | lines.join("\n")
68 | }
69 | }
70 |
71 | impl From for ApprovalRequest {
72 | fn from(value: protos::GetApprovalRequest) -> Self {
73 | Self {
74 | id: ApprovalID::new(),
75 | name: value.name,
76 | parameters: value.parameters,
77 | context: Self::sanitize_context(value.context),
78 | }
79 | }
80 | }
81 |
82 | #[derive(Debug, Clone, Serialize, Deserialize)]
83 | pub struct ApprovalResponse {
84 | pub id: ApprovalID,
85 | pub approved: bool,
86 | pub parameters: String,
87 | pub approver: Approver,
88 | }
89 |
90 | impl From for protos::GetApprovalResponse {
91 | fn from(value: ApprovalResponse) -> Self {
92 | let approved = value.approved;
93 | let parameters = value.parameters;
94 | Self { approved, parameters }
95 | }
96 | }
97 |
98 | #[derive(Debug, Clone, Serialize, Deserialize)]
99 | pub struct Approver {
100 | pub name: String,
101 | pub email: String,
102 | }
103 |
--------------------------------------------------------------------------------
/src/services/receiver.rs:
--------------------------------------------------------------------------------
1 | use super::*;
2 | use protos::receiver_server::Receiver;
3 | use tokio::sync::oneshot;
4 |
5 | #[tonic::async_trait]
6 | impl Receiver for Arc {
7 | async fn heartbeat(
8 | &self,
9 | _request: Request<()>,
10 | ) -> Result, Status> {
11 | let response = protos::HeartbeatResponse {
12 | version: env!("CARGO_PKG_VERSION").to_string(),
13 | };
14 |
15 | Ok(Response::new(response))
16 | }
17 |
18 | async fn get_approval(
19 | &self,
20 | request: Request,
21 | ) -> Result, Status> {
22 | let request = request.into_inner();
23 | let connection_id = match self.get_lightest_connection() {
24 | Some(id) => id,
25 | None => {
26 | if self.config.auto_approve {
27 | return Ok(Response::new(protos::GetApprovalResponse {
28 | approved: true,
29 | parameters: request.parameters.clone(),
30 | }));
31 | } else {
32 | let message = "No approver is available at the moment";
33 | return Err(Status::unavailable(message));
34 | }
35 | },
36 | };
37 |
38 | // Unwrap is safe because the connection ID is guaranteed to exist.
39 | let connection = self.get_connection(&connection_id).unwrap();
40 | let message = ApprovalRequest::from(request);
41 | let approval_id = message.id;
42 | tracing::info!("An approval request is created: {approval_id}");
43 |
44 | // Create a one-time use WebSocket channel to coordinate the
45 | // approval response from the approver. The sender is used to send
46 | // the approval response from our general WebSocket receiver to
47 | // the oneshot receiver.
48 | let (os_sender, os_receiver) = oneshot::channel::();
49 |
50 | // Send the serialized approval request to the approver.
51 | let message = serde_json::to_string(&message).unwrap();
52 | if connection.sender.send(Message::Text(message)).is_err() {
53 | let message = "Failed to send the message to the approver";
54 | return Err(Status::unavailable(message));
55 | }
56 |
57 | self.add_load(&connection_id);
58 | self.add_approval(approval_id, os_sender);
59 |
60 | // Wait for the approval response from the approver.
61 | let result = os_receiver.await.map_err(|_| {
62 | Status::internal("Failed to receive approval response")
63 | })?;
64 |
65 | let approver = &result.approver.name;
66 | let verdict = match result.approved {
67 | true => "approved",
68 | false => "rejected",
69 | };
70 |
71 | tracing::info!("The request {approval_id} is {verdict} by {approver}");
72 | self.reduce_load(&connection_id);
73 | Ok(Response::new(result.into()))
74 | }
75 | }
76 |
77 | #[cfg(test)]
78 | mod tests {
79 | use super::*;
80 |
81 | #[tokio::test]
82 | async fn test_heartbeat() {
83 | let config = Configuration::default();
84 | let phantasm = Phantasm::open(&config).unwrap();
85 | let service = Arc::new(phantasm);
86 |
87 | let request = Request::new(());
88 | let response = service.heartbeat(request).await.unwrap();
89 |
90 | let version = env!("CARGO_PKG_VERSION");
91 | assert_eq!(response.get_ref().version, version);
92 | }
93 | }
94 |
--------------------------------------------------------------------------------
/dashboard/src/routes/connections/[id]/+page.svelte:
--------------------------------------------------------------------------------
1 |
101 |
102 |
59 |
95 |
96 | (optional scope):
113 | ```
114 |
115 | Source: [Convention Commits](https://www.conventionalcommits.org)
116 |
--------------------------------------------------------------------------------
/clients/python/phantasmpy/client.py:
--------------------------------------------------------------------------------
1 | import grpc
2 | import json
3 | from typing import Any, Callable
4 | from functools import wraps
5 | from google.protobuf.empty_pb2 import Empty
6 | from .stubs import receiver_pb2 as protos
7 | from .stubs.receiver_pb2_grpc import ReceiverStub
8 | from .types import HeartbeatResponse, GetApprovalResponse
9 |
10 |
11 | class Phantasm:
12 | """Create a Phantasm client to interact with the receiver service.
13 |
14 | Args:
15 | - host: Hostname of the receiver service.
16 | - port: Port where the receiver listens for requests.
17 | - secret: Key used to authenticate the client with the receiver.
18 | """
19 |
20 | def __init__(
21 | self,
22 | host: str = "localhost",
23 | port: int = 2505,
24 | secret: str = "",
25 | ):
26 | channel = grpc.insecure_channel(f"{host}:{port}")
27 | self.connection = ReceiverStub(channel)
28 | self.metadata = [("authorization", secret)]
29 |
30 | def heartbeat(self) -> HeartbeatResponse:
31 | """Check if the client can connect to the receiver service."""
32 |
33 | response = self.connection.Heartbeat(
34 | request=Empty(),
35 | metadata=self.metadata,
36 | )
37 |
38 | return HeartbeatResponse(version=response.version)
39 |
40 | def get_approval(
41 | self,
42 | name: str,
43 | parameters: Any,
44 | context: str = "",
45 | ) -> GetApprovalResponse:
46 | """Request approval for an operation from the approver.
47 |
48 | Args:
49 | - name: Name of the operation, typically, the function name.
50 | - parameters: Parameters used in the operation.
51 | - context: Additional information about the operation.
52 |
53 | Parameters will be relayed as a JSON string to the approver. The
54 | approver can choose to modify the parameters with the correct values
55 | before approving the request.
56 | """
57 |
58 | try:
59 | request = protos.GetApprovalRequest(
60 | name=name,
61 | parameters=json.dumps(parameters),
62 | context=context,
63 | )
64 | except Exception as e:
65 | raise ValueError(f"Invalid parameters: {e}")
66 |
67 | response = self.connection.GetApproval(
68 | request=request,
69 | metadata=self.metadata,
70 | )
71 |
72 | return GetApprovalResponse(
73 | approved=response.approved,
74 | parameters=response.parameters or "",
75 | )
76 |
77 | def require_approval(self, with_parameters: bool = True) -> Callable:
78 | """Decorator to request approval before executing a function.
79 |
80 | By default, the decorator will use the parameters provided by the
81 | approvers to call the function. If you want to use the original
82 | parameters, set `with_parameters` to false.
83 |
84 | This decorator raises exceptions if:
85 | - The approval request is rejected.
86 | - Error when requesting approval from the server.
87 |
88 | Example:
89 |
90 | ```py
91 | phantasm = Phantasm()
92 | @phantasm.require_approval()
93 | def double(x: int) -> int:
94 | return x * 2
95 |
96 | double(x=5)
97 | ```
98 | """
99 |
100 | def decorator(function: Callable) -> Callable:
101 | @wraps(function)
102 | def wrapper(**kwargs) -> Callable:
103 | name = function.__name__
104 | docs = function.__doc__ or ""
105 | response = self.get_approval(
106 | name=name,
107 | parameters=kwargs,
108 | context=docs,
109 | )
110 |
111 | if response.approved:
112 | if with_parameters:
113 | kwargs = response.parameters
114 | return function(**kwargs)
115 |
116 | raise PermissionError("The approval request is not approved.")
117 |
118 | return wrapper
119 |
120 | return decorator
121 |
122 |
123 | def test_get_approval():
124 | phantasm = Phantasm()
125 |
126 | @phantasm.require_approval()
127 | def multiply(x: int, y: int) -> int:
128 | """Multiply two numbers, x and y."""
129 | return x * y
130 |
131 | print(multiply(x=5, y=10))
132 |
--------------------------------------------------------------------------------
/.github/CODE_OF_CONDUCT.md:
--------------------------------------------------------------------------------
1 | # Contributor Covenant Code of Conduct
2 |
3 | ## Our Pledge
4 |
5 | We as members, contributors, and leaders pledge to make participation in our
6 | community a harassment-free experience for everyone, regardless of age, body
7 | size, visible or invisible disability, ethnicity, sex characteristics, gender
8 | identity and expression, level of experience, education, socio-economic status,
9 | nationality, personal appearance, race, caste, color, religion, or sexual
10 | identity and orientation.
11 |
12 | We pledge to act and interact in ways that contribute to an open, welcoming,
13 | diverse, inclusive, and healthy community.
14 |
15 | ## Our Standards
16 |
17 | Examples of behavior that contributes to a positive environment for our
18 | community include:
19 |
20 | - Demonstrating empathy and kindness toward other people
21 | - Being respectful of differing opinions, viewpoints, and experiences
22 | - Giving and gracefully accepting constructive feedback
23 | - Accepting responsibility and apologizing to those affected by our mistakes,
24 | and learning from the experience
25 | - Focusing on what is best not just for us as individuals, but for the overall
26 | community
27 |
28 | Examples of unacceptable behavior include:
29 |
30 | - The use of sexualized language or imagery, and sexual attention or advances of
31 | any kind
32 | - Trolling, insulting or derogatory comments, and personal or political attacks
33 | - Public or private harassment
34 | - Publishing others' private information, such as a physical or email address,
35 | without their explicit permission
36 | - Other conduct which could reasonably be considered inappropriate in a
37 | professional setting
38 |
39 | ## Enforcement Responsibilities
40 |
41 | Community leaders are responsible for clarifying and enforcing our standards of
42 | acceptable behavior and will take appropriate and fair corrective action in
43 | response to any behavior that they deem inappropriate, threatening, offensive,
44 | or harmful.
45 |
46 | Community leaders have the right and responsibility to remove, edit, or reject
47 | comments, commits, code, wiki edits, issues, and other contributions that are
48 | not aligned to this Code of Conduct, and will communicate reasons for moderation
49 | decisions when appropriate.
50 |
51 | ## Scope
52 |
53 | This Code of Conduct applies within all community spaces, and also applies when
54 | an individual is officially representing the community in public spaces.
55 | Examples of representing our community include using an official email address,
56 | posting via an official social media account, or acting as an appointed
57 | representative at an online or offline event.
58 |
59 | ## Enforcement
60 |
61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be
62 | reported to the community leaders responsible for enforcement at
63 | edwin@oasysai.com. All complaints will be reviewed and investigated promptly and
64 | fairly.
65 |
66 | All community leaders are obligated to respect the privacy and security of the
67 | reporter of any incident.
68 |
69 | ## Enforcement Guidelines
70 |
71 | Community leaders will follow these Community Impact Guidelines in determining
72 | the consequences for any action they deem in violation of this Code of Conduct:
73 |
74 | ### 1. Correction
75 |
76 | **Community Impact**: Use of inappropriate language or other behavior deemed
77 | unprofessional or unwelcome in the community.
78 |
79 | **Consequence**: A private, written warning from community leaders, providing
80 | clarity around the nature of the violation and an explanation of why the
81 | behavior was inappropriate. A public apology may be requested.
82 |
83 | ### 2. Warning
84 |
85 | **Community Impact**: A violation through a single incident or series of
86 | actions.
87 |
88 | **Consequence**: A warning with consequences for continued behavior. No
89 | interaction with the people involved, including unsolicited interaction with
90 | those enforcing the Code of Conduct, for a specified period of time. This
91 | includes avoiding interactions in community spaces as well as external channels
92 | like social media. Violating these terms may lead to a temporary or permanent
93 | ban.
94 |
95 | ### 3. Temporary Ban
96 |
97 | **Community Impact**: A serious violation of community standards, including
98 | sustained inappropriate behavior.
99 |
100 | **Consequence**: A temporary ban from any sort of interaction or public
101 | communication with the community for a specified period of time. No public or
102 | private interaction with the people involved, including unsolicited interaction
103 | with those enforcing the Code of Conduct, is allowed during this period.
104 | Violating these terms may lead to a permanent ban.
105 |
106 | ### 4. Permanent Ban
107 |
108 | **Community Impact**: Demonstrating a pattern of violation of community
109 | standards, including sustained inappropriate behavior, harassment of an
110 | individual, or aggression toward or disparagement of classes of individuals.
111 |
112 | **Consequence**: A permanent ban from any sort of public interaction within the
113 | community.
114 |
115 | ## Attribution
116 |
117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage],
118 | version 2.1. The Community Impact Guidelines were inspired by [Mozilla's Code of
119 | Conduct Enforcement Ladder][mozilla_coc].
120 |
121 | [homepage]: https://www.contributor-covenant.org
122 | [mozilla_coc]: https://github.com/mozilla/diversity
123 |
--------------------------------------------------------------------------------
/src/services/mod.rs:
--------------------------------------------------------------------------------
1 | mod receiver;
2 |
3 | // Import common modules below.
4 | use crate::protos;
5 | use crate::types::*;
6 | use std::collections::HashMap;
7 | use std::env;
8 | use std::error::Error;
9 | use std::sync::{Arc, Mutex};
10 | use tokio::sync::oneshot::Sender;
11 | use tokio_tungstenite::tungstenite::Message;
12 | use tonic::{Request, Response, Status};
13 |
14 | #[derive(Debug, Clone)]
15 | pub struct Configuration {
16 | pub auto_approve: bool,
17 | }
18 |
19 | #[cfg(test)]
20 | impl Default for Configuration {
21 | fn default() -> Self {
22 | Configuration { auto_approve: false }
23 | }
24 | }
25 |
26 | #[derive(Debug)]
27 | pub struct Phantasm {
28 | config: Configuration,
29 | connections: Mutex>,
30 | approvals: Mutex>>,
31 | }
32 |
33 | impl Phantasm {
34 | pub fn open(config: &Configuration) -> Result> {
35 | Ok(Phantasm {
36 | config: config.clone(),
37 | connections: Mutex::new(HashMap::new()),
38 | approvals: Mutex::new(HashMap::new()),
39 | })
40 | }
41 |
42 | pub async fn receive_message(&self, message: &Message) {
43 | let message = match message {
44 | Message::Text(text) => text,
45 | _ => return,
46 | };
47 |
48 | let message: ApprovalResponse = match serde_json::from_str(message) {
49 | Ok(message) => message,
50 | Err(error) => {
51 | tracing::error!("Failed to parse the message: {error}");
52 | return;
53 | },
54 | };
55 |
56 | // Send the approval response via the oneshot sender to the oneshot
57 | // receiver to complete the approval request.
58 | let approval_id = message.id;
59 | if let Some(sender) = self.remove_approval(&approval_id) {
60 | let _ = sender.send(message);
61 | }
62 | }
63 |
64 | pub fn add_connection(&self, id: ConnectionID, connection: Connection) {
65 | let mut connections = self.connections.lock().unwrap();
66 | connections.insert(id, connection);
67 | }
68 |
69 | pub fn remove_connection(&self, id: &ConnectionID) {
70 | let mut connections = self.connections.lock().unwrap();
71 | connections.remove(id);
72 | }
73 |
74 | fn get_connection(&self, id: &ConnectionID) -> Option {
75 | let connections = self.connections.lock().unwrap();
76 | connections.get(id).cloned()
77 | }
78 |
79 | /// Get the connection with the smallest load.
80 | ///
81 | /// Load refers to the number of approval requests that are currently
82 | /// being processed by the connection. This method is used to distribute
83 | /// the approval requests somewhat evenly among the connections.
84 | fn get_lightest_connection(&self) -> Option {
85 | let connections = self.connections.lock().unwrap();
86 | connections
87 | .iter()
88 | .min_by_key(|(_, connection)| connection.load)
89 | .map(|(id, _)| *id)
90 | }
91 |
92 | fn add_load(&self, id: &ConnectionID) {
93 | let mut connections = self.connections.lock().unwrap();
94 | if let Some(connection) = connections.get_mut(id) {
95 | connection.load += 1;
96 | }
97 | }
98 |
99 | fn reduce_load(&self, id: &ConnectionID) {
100 | let mut connections = self.connections.lock().unwrap();
101 | if let Some(connection) = connections.get_mut(id) {
102 | if connection.load > 0 {
103 | connection.load -= 1;
104 | }
105 | }
106 | }
107 |
108 | fn add_approval(&self, id: ApprovalID, sender: Sender) {
109 | let mut approvals = self.approvals.lock().unwrap();
110 | approvals.insert(id, sender);
111 | }
112 |
113 | fn remove_approval(
114 | &self,
115 | id: &ApprovalID,
116 | ) -> Option> {
117 | let mut approvals = self.approvals.lock().unwrap();
118 | approvals.remove(id)
119 | }
120 | }
121 |
122 | #[cfg(test)]
123 | mod tests {
124 | use super::*;
125 | use serde_json::json;
126 |
127 | #[tokio::test]
128 | async fn test_receive_message() {
129 | let config = Configuration::default();
130 | let phantasm = Phantasm::open(&config).unwrap();
131 |
132 | // Simulate queueing a pending approval request.
133 | let approval_id = ApprovalID::new();
134 | let (sender, _) = tokio::sync::oneshot::channel();
135 | phantasm.add_approval(approval_id, sender);
136 |
137 | // Simulate receiving an approval response message.
138 | let params = json!({ "key": "value" });
139 | let response = ApprovalResponse {
140 | id: approval_id,
141 | approved: true,
142 | parameters: params.to_string(),
143 | approver: Approver {
144 | name: "Alice".to_string(),
145 | email: "alice@thewonderland.com".to_string(),
146 | },
147 | };
148 |
149 | let response_string = serde_json::to_string(&response).unwrap();
150 | let message = Message::Text(response_string);
151 | phantasm.receive_message(&message).await;
152 |
153 | // There should be no pending approvals after receiving the message
154 | // since the pending approval will be completed and removed.
155 | let approvals = phantasm.approvals.lock().unwrap();
156 | assert!(approvals.is_empty());
157 | }
158 | }
159 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/cards/approval.svelte:
--------------------------------------------------------------------------------
1 |
97 |
98 | {request.id}
99 |
100 | "Port for the receiver server")
44 | .default_value("2505")
45 | .value_parser(clap::value_parser!(u16));
46 |
47 | let arg_coordinator_port =
48 | arg!(--"coordinator-port" "Port for the coordinator server")
49 | .default_value("2510")
50 | .value_parser(clap::value_parser!(u16));
51 |
52 | Command::new(START_COMMAND)
53 | .alias("run")
54 | .about("Start the receiver and the coordinator servers")
55 | .arg(arg_receiver_port)
56 | .arg(arg_coordinator_port)
57 | }
58 |
59 | fn configuration() -> Configuration {
60 | let auto_approve = env::var("PHANTASM_AUTO_APPROVE")
61 | .map(|value| value.parse::().unwrap_or_default())
62 | .unwrap_or_default();
63 |
64 | Configuration { auto_approve }
65 | }
66 |
67 | async fn start_handler(args: &ArgMatches) {
68 | // Unwrapping is safe here because the arguments are validated by Clap.
69 | let receiver_port = *args.get_one::("receiver-port").unwrap();
70 | let coordinator_port = *args.get_one::("coordinator-port").unwrap();
71 |
72 | let config = configuration();
73 | let phantasm = Phantasm::open(&config).expect("Failed to open Phantasm");
74 | let service = Arc::new(phantasm);
75 |
76 | let receiver_service = service.clone();
77 | let receiver_server = tokio::spawn(async move {
78 | start_receiver_server(receiver_service, receiver_port).await
79 | });
80 |
81 | let coordinator_service = service.clone();
82 | let coordinator_server = tokio::spawn(async move {
83 | start_coordinator_server(coordinator_service, coordinator_port).await
84 | });
85 |
86 | let _ = tokio::join!(receiver_server, coordinator_server);
87 | }
88 |
89 | async fn start_receiver_server(service: Arc, port: u16) {
90 | let service = ReceiverServer::with_interceptor(service, auth_interceptor);
91 | let addr = format!("[::]:{port}").parse().unwrap();
92 | tracing::info!("The receiver server is ready on port {port}");
93 |
94 | Server::builder()
95 | .add_service(service)
96 | .serve(addr)
97 | .await
98 | .expect("Failed to start the receiver server");
99 | }
100 |
101 | fn auth_interceptor(request: Request<()>) -> Result, Status> {
102 | let secret = env::var("PHANTASM_SECRET").unwrap_or_default();
103 | if secret.is_empty() {
104 | return Ok(request);
105 | }
106 |
107 | let unauthorized = {
108 | let message = "Invalid or missing authorization key";
109 | Status::unauthenticated(message)
110 | };
111 |
112 | if let Some(auth) = request.metadata().get("authorization") {
113 | let auth = auth.to_str().map_err(|_| unauthorized.clone())?;
114 | if auth == secret.as_str() {
115 | return Ok(request);
116 | }
117 | }
118 |
119 | Err(unauthorized)
120 | }
121 |
122 | async fn start_coordinator_server(service: Arc, port: u16) {
123 | let addr = format!("[::]:{port}");
124 | let listener = TcpListener::bind(addr).await.unwrap();
125 |
126 | tracing::info!("The coordinator server is ready on port {port}");
127 |
128 | while let Ok((stream, _)) = listener.accept().await {
129 | let peer_addr = stream
130 | .peer_addr()
131 | .expect("Connected streams should have a peer address");
132 |
133 | let mut peer_ip = peer_addr.ip().to_canonical();
134 | if peer_ip.is_loopback() {
135 | peer_ip = IpAddr::V4(Ipv4Addr::LOCALHOST);
136 | }
137 |
138 | tracing::info!("A connection is established with {peer_ip}");
139 |
140 | let service = service.clone();
141 | tokio::spawn(async move {
142 | let websocket = accept_async(stream).await.unwrap();
143 | let (mut writer, mut reader) = websocket.split();
144 | let (sender, mut receiver) = mpsc::unbounded_channel();
145 |
146 | let connection_id = ConnectionID::new();
147 | let connection = Connection::new(sender);
148 | service.add_connection(connection_id, connection);
149 |
150 | tokio::spawn(async move {
151 | while let Some(Ok(message)) = reader.next().await {
152 | service.receive_message(&message).await
153 | }
154 |
155 | service.remove_connection(&connection_id);
156 | tracing::info!("A connection is closed: {peer_ip}");
157 | });
158 |
159 | tokio::spawn(async move {
160 | while let Some(message) = receiver.recv().await {
161 | if writer.send(message).await.is_err() {
162 | break;
163 | }
164 | }
165 | });
166 | });
167 | }
168 | }
169 |
--------------------------------------------------------------------------------
/clients/python/phantasmpy/stubs/receiver_pb2_grpc.py:
--------------------------------------------------------------------------------
1 | # Generated by the gRPC Python protocol compiler plugin. DO NOT EDIT!
2 | """Client and server classes corresponding to protobuf-defined services."""
3 | import grpc
4 | import warnings
5 |
6 | from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
7 | from . import receiver_pb2 as receiver__pb2
8 |
9 | GRPC_GENERATED_VERSION = "1.67.0"
10 | GRPC_VERSION = grpc.__version__
11 | _version_not_supported = False
12 |
13 | try:
14 | from grpc._utilities import first_version_is_lower
15 |
16 | _version_not_supported = first_version_is_lower(
17 | GRPC_VERSION, GRPC_GENERATED_VERSION
18 | )
19 | except ImportError:
20 | _version_not_supported = True
21 |
22 | if _version_not_supported:
23 | raise RuntimeError(
24 | f"The grpc package installed is at version {GRPC_VERSION},"
25 | + f" but the generated code in receiver_pb2_grpc.py depends on"
26 | + f" grpcio>={GRPC_GENERATED_VERSION}."
27 | + f" Please upgrade your grpc module to grpcio>={GRPC_GENERATED_VERSION}"
28 | + f" or downgrade your generated code using grpcio-tools<={GRPC_VERSION}."
29 | )
30 |
31 |
32 | class ReceiverStub(object):
33 | """Receiver service definition.
34 |
35 | The receiver service is used to receive an approval requests from the
36 | client SDK. This requests can then be relayed to the coordinator service
37 | to be dispatched to the appropriate approvers.
38 | """
39 |
40 | def __init__(self, channel):
41 | """Constructor.
42 |
43 | Args:
44 | channel: A grpc.Channel.
45 | """
46 | self.Heartbeat = channel.unary_unary(
47 | "/receiver.Receiver/Heartbeat",
48 | request_serializer=google_dot_protobuf_dot_empty__pb2.Empty.SerializeToString,
49 | response_deserializer=receiver__pb2.HeartbeatResponse.FromString,
50 | _registered_method=True,
51 | )
52 | self.GetApproval = channel.unary_unary(
53 | "/receiver.Receiver/GetApproval",
54 | request_serializer=receiver__pb2.GetApprovalRequest.SerializeToString,
55 | response_deserializer=receiver__pb2.GetApprovalResponse.FromString,
56 | _registered_method=True,
57 | )
58 |
59 |
60 | class ReceiverServicer(object):
61 | """Receiver service definition.
62 |
63 | The receiver service is used to receive an approval requests from the
64 | client SDK. This requests can then be relayed to the coordinator service
65 | to be dispatched to the appropriate approvers.
66 | """
67 |
68 | def Heartbeat(self, request, context):
69 | """Check if the receiver service is running."""
70 | context.set_code(grpc.StatusCode.UNIMPLEMENTED)
71 | context.set_details("Method not implemented!")
72 | raise NotImplementedError("Method not implemented!")
73 |
74 | def GetApproval(self, request, context):
75 | """Create a new approval request for the approvers to review."""
76 | context.set_code(grpc.StatusCode.UNIMPLEMENTED)
77 | context.set_details("Method not implemented!")
78 | raise NotImplementedError("Method not implemented!")
79 |
80 |
81 | def add_ReceiverServicer_to_server(servicer, server):
82 | rpc_method_handlers = {
83 | "Heartbeat": grpc.unary_unary_rpc_method_handler(
84 | servicer.Heartbeat,
85 | request_deserializer=google_dot_protobuf_dot_empty__pb2.Empty.FromString,
86 | response_serializer=receiver__pb2.HeartbeatResponse.SerializeToString,
87 | ),
88 | "GetApproval": grpc.unary_unary_rpc_method_handler(
89 | servicer.GetApproval,
90 | request_deserializer=receiver__pb2.GetApprovalRequest.FromString,
91 | response_serializer=receiver__pb2.GetApprovalResponse.SerializeToString,
92 | ),
93 | }
94 | generic_handler = grpc.method_handlers_generic_handler(
95 | "receiver.Receiver", rpc_method_handlers
96 | )
97 | server.add_generic_rpc_handlers((generic_handler,))
98 | server.add_registered_method_handlers(
99 | "receiver.Receiver", rpc_method_handlers
100 | )
101 |
102 |
103 | # This class is part of an EXPERIMENTAL API.
104 | class Receiver(object):
105 | """Receiver service definition.
106 |
107 | The receiver service is used to receive an approval requests from the
108 | client SDK. This requests can then be relayed to the coordinator service
109 | to be dispatched to the appropriate approvers.
110 | """
111 |
112 | @staticmethod
113 | def Heartbeat(
114 | request,
115 | target,
116 | options=(),
117 | channel_credentials=None,
118 | call_credentials=None,
119 | insecure=False,
120 | compression=None,
121 | wait_for_ready=None,
122 | timeout=None,
123 | metadata=None,
124 | ):
125 | return grpc.experimental.unary_unary(
126 | request,
127 | target,
128 | "/receiver.Receiver/Heartbeat",
129 | google_dot_protobuf_dot_empty__pb2.Empty.SerializeToString,
130 | receiver__pb2.HeartbeatResponse.FromString,
131 | options,
132 | channel_credentials,
133 | insecure,
134 | call_credentials,
135 | compression,
136 | wait_for_ready,
137 | timeout,
138 | metadata,
139 | _registered_method=True,
140 | )
141 |
142 | @staticmethod
143 | def GetApproval(
144 | request,
145 | target,
146 | options=(),
147 | channel_credentials=None,
148 | call_credentials=None,
149 | insecure=False,
150 | compression=None,
151 | wait_for_ready=None,
152 | timeout=None,
153 | metadata=None,
154 | ):
155 | return grpc.experimental.unary_unary(
156 | request,
157 | target,
158 | "/receiver.Receiver/GetApproval",
159 | receiver__pb2.GetApprovalRequest.SerializeToString,
160 | receiver__pb2.GetApprovalResponse.FromString,
161 | options,
162 | channel_credentials,
163 | insecure,
164 | call_credentials,
165 | compression,
166 | wait_for_ready,
167 | timeout,
168 | metadata,
169 | _registered_method=True,
170 | )
171 |
--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | [][github]
2 | [][discord]
3 | [][license]
4 |
5 | [discord]: https://discord.gg/dgevsYhh7P
6 | [github]: https://github.com/phantasmlabs/phantasm
7 | [license]: https://github.com/phantasmlabs/phantasm/blob/main/LICENSE
8 |
9 | 
10 |
11 | Phantasm offers open-source toolkits that allows you to create human-in-the-loop
12 | (HITL) workflows for modern AI agents. Phantasm comes with 3 main components
13 | that work together to create a seamless HITL experience:
14 |
15 | - **Server**: Coordinating the HITL workflows between humans and AI agents.
16 | - **Dashboard**: For the human team to monitor and manage the workflows.
17 | - **Client**: A library to integrate the workflows into your AI agents.
18 |
19 | ## Features
20 |
21 | - ✅ Fully open-source and free to use
22 | - ✅ Works out of the box with any AI framework or model
23 | - ✅ Load balancer to distribute the requests to multiple approvers (Beta)
24 | - ✅ Web-based dashboard to manage the approval workflows
25 | - ✅ Easy-to-use client libraries for popular programming languages
26 |
27 | ## How It Works
28 |
29 | Phantasm allows you to have an approval layer on top of your AI agents. This
30 | means, you're free to use any AI framework or model you see fit. By using
31 | Phantasm, you can delay the execution of certain business critical actions by
32 | your AI agents until a human approves them.
33 |
34 | This is particularly useful in scenarios where the AI agent is not 100% accurate
35 | or the cost of making a mistake is high. For example, an AI agent that can
36 | automate calendar scheduling. In this case, you can use Phantasm to make sure
37 | that the AI agent schedules the right meetings at the right time.
38 |
39 | Here's how it works under the hood:
40 |
41 | 1. Your AI agent sends an approval request to Phantasm's server.
42 | 2. Phantasm relays the request to a human approver.
43 | 3. The approver reviews the request and either approves or rejects it.
44 | 4. Phantasm sends the decision back to the AI agent.
45 |
46 | Phantasm can also relay the action parameters to the approvers. This parameters
47 | can be modified by the approvers before approving the action. This is useful if
48 | there is only a slight mistake in the action parameters that can be corrected by
49 | the approvers. This way the action can be approved with some modifications
50 | instead of rejected.
51 |
52 | 
53 |
54 | ## Getting Started
55 |
56 | The easiest way to get started with Phantasm is by using Docker. There are 2
57 | components that you need to run before you can start using Phantasm: **Server**
58 | and **Dashboard**. To run these components, first, you need to pull the Docker
59 | images of these components.
60 |
61 | These Docker images are hosted on GitHub Container Registry:
62 | [Packages](https://github.com/orgs/phantasmlabs/packages?repo_name=phantasm)
63 |
64 | ```bash
65 | docker pull ghcr.io/phantasmlabs/phantasm/dashboard:latest
66 | docker pull ghcr.io/phantasmlabs/phantasm/server:latest
67 | ```
68 |
69 | After pulling the images, you can run the components with these commands:
70 |
71 | ```bash
72 | docker run -d -p 2515:2515 ghcr.io/phantasmlabs/phantasm/dashboard:latest
73 | docker run -d -p 2505:2505 -p 2510:2510 ghcr.io/phantasmlabs/phantasm/server:latest start
74 | ```
75 |
76 | After running the components, you will have access to:
77 |
78 | - **Dashboard**: [localhost:2515](http://localhost:2515)
79 | - **Receiver Server**: localhost:2505
80 | - **Coordinator Server**: localhost:2510
81 |
82 | You can use the dashboard to manage the approval workflows by adding a
83 | connection to Phantasm's Coordinator Server. The Receiver Server is used to
84 | receive the approval requests from the AI agents via Phantasm's client library.
85 | Depending on the programming language you use, you can choose the appropriate
86 | client library from the list below:
87 |
88 | - [Python](https://pypi.org/project/phantasmpy)
89 |
90 | ## Best Practices
91 |
92 | ### Error Handling & Fallback Mechanism
93 |
94 | Phantasm is designed for real-time approval workflows for AI agents with some
95 | non-technical dependencies that could be unpredictable such as the availability
96 | of the approvers. Therefore, it is important to have good error handling and
97 | fallback mechanisms in place. Here are some edge cases that you should consider
98 | before using Phantasm in production:
99 |
100 | - No approver is available to monitor and approve the action.
101 | - The approver is not able to approve the action within a certain time frame.
102 | - The approver rejects the action from being executed by the AI agent.
103 |
104 | To handle these edge cases, you can use the following strategies:
105 |
106 | - Set a timeout for the approval request based on the urgency of the action.
107 | - Create fall-back actions for timed out or rejected approval requests.
108 | - Retry the approval request method if the approver is not available.
109 | - Notify an approver via email if no approver is available at the time.
110 | - Other strategies that are specific to your use case...
111 |
112 | ### Parameters & Context
113 |
114 | When sending an approval request using Phantasm, you can also send the action
115 | parameters and context to be relayed to the approvers. Most of the time, you
116 | want to use this feature to help the approvers make an informed decision.
117 | Parameters are usually the input values of the action while the context is the
118 | additional information that can help the approvers understand the action better.
119 |
120 | Here are some best practices when sending parameters and context:
121 |
122 | - Send the parameters generated by the AI agent as an object or dictionary.
123 | - When reviewing the action, make sure the parameters are correct and valid.
124 | - Send the action documentation with parameters explanation in the context.
125 | - Optionally, include context from the end-user such as messages or triggers.
126 |
127 | ## Contributing
128 |
129 | The easiest way to contribute to Phantasm is by starring the repository and
130 | sharing it with your colleagues. By doing so, you help us reach a wider audience
131 | and grow the community. If you are interested in contributing to the project in
132 | the form of code, design, or documentation, please read our
133 | [Contributing Guidelines](.github/CONTRIBUTING.md).
134 |
135 | Other than the clients, which is licensed under the MIT License, Phantasm is
136 | licensed under the GNU General Public License v3.0. By contributing to the
137 | project, you agree to license your contributions under the applicable license.
138 | For more information, please read our licenses:
139 |
140 | - [MIT License](clients/LICENSE)
141 | - [GNU General Public License v3.0](LICENSE)
142 |
143 | ## Disclaimer
144 |
145 | Phantasm is still in its early stages of development. Therefore, use it at your
146 | own risk. With that being said, we are actively working on improving the
147 | toolkits and adding essential features to make it more robust and secure. We
148 | will be happy if you actually use it and provide us with feedback to make it
149 | better.
150 |
--------------------------------------------------------------------------------
/clients/python/poetry.lock:
--------------------------------------------------------------------------------
1 | # This file is automatically @generated by Poetry 1.8.4 and should not be changed by hand.
2 |
3 | [[package]]
4 | name = "black"
5 | version = "24.10.0"
6 | description = "The uncompromising code formatter."
7 | optional = false
8 | python-versions = ">=3.9"
9 | files = [
10 | {file = "black-24.10.0-cp310-cp310-macosx_10_9_x86_64.whl", hash = "sha256:e6668650ea4b685440857138e5fe40cde4d652633b1bdffc62933d0db4ed9812"},
11 | {file = "black-24.10.0-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:1c536fcf674217e87b8cc3657b81809d3c085d7bf3ef262ead700da345bfa6ea"},
12 | {file = "black-24.10.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:649fff99a20bd06c6f727d2a27f401331dc0cc861fb69cde910fe95b01b5928f"},
13 | {file = "black-24.10.0-cp310-cp310-win_amd64.whl", hash = "sha256:fe4d6476887de70546212c99ac9bd803d90b42fc4767f058a0baa895013fbb3e"},
14 | {file = "black-24.10.0-cp311-cp311-macosx_10_9_x86_64.whl", hash = "sha256:5a2221696a8224e335c28816a9d331a6c2ae15a2ee34ec857dcf3e45dbfa99ad"},
15 | {file = "black-24.10.0-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:f9da3333530dbcecc1be13e69c250ed8dfa67f43c4005fb537bb426e19200d50"},
16 | {file = "black-24.10.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:4007b1393d902b48b36958a216c20c4482f601569d19ed1df294a496eb366392"},
17 | {file = "black-24.10.0-cp311-cp311-win_amd64.whl", hash = "sha256:394d4ddc64782e51153eadcaaca95144ac4c35e27ef9b0a42e121ae7e57a9175"},
18 | {file = "black-24.10.0-cp312-cp312-macosx_10_13_x86_64.whl", hash = "sha256:b5e39e0fae001df40f95bd8cc36b9165c5e2ea88900167bddf258bacef9bbdc3"},
19 | {file = "black-24.10.0-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:d37d422772111794b26757c5b55a3eade028aa3fde43121ab7b673d050949d65"},
20 | {file = "black-24.10.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:14b3502784f09ce2443830e3133dacf2c0110d45191ed470ecb04d0f5f6fcb0f"},
21 | {file = "black-24.10.0-cp312-cp312-win_amd64.whl", hash = "sha256:30d2c30dc5139211dda799758559d1b049f7f14c580c409d6ad925b74a4208a8"},
22 | {file = "black-24.10.0-cp313-cp313-macosx_10_13_x86_64.whl", hash = "sha256:1cbacacb19e922a1d75ef2b6ccaefcd6e93a2c05ede32f06a21386a04cedb981"},
23 | {file = "black-24.10.0-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:1f93102e0c5bb3907451063e08b9876dbeac810e7da5a8bfb7aeb5a9ef89066b"},
24 | {file = "black-24.10.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ddacb691cdcdf77b96f549cf9591701d8db36b2f19519373d60d31746068dbf2"},
25 | {file = "black-24.10.0-cp313-cp313-win_amd64.whl", hash = "sha256:680359d932801c76d2e9c9068d05c6b107f2584b2a5b88831c83962eb9984c1b"},
26 | {file = "black-24.10.0-cp39-cp39-macosx_10_9_x86_64.whl", hash = "sha256:17374989640fbca88b6a448129cd1745c5eb8d9547b464f281b251dd00155ccd"},
27 | {file = "black-24.10.0-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:63f626344343083322233f175aaf372d326de8436f5928c042639a4afbbf1d3f"},
28 | {file = "black-24.10.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.manylinux_2_28_x86_64.whl", hash = "sha256:ccfa1d0cb6200857f1923b602f978386a3a2758a65b52e0950299ea014be6800"},
29 | {file = "black-24.10.0-cp39-cp39-win_amd64.whl", hash = "sha256:2cd9c95431d94adc56600710f8813ee27eea544dd118d45896bb734e9d7a0dc7"},
30 | {file = "black-24.10.0-py3-none-any.whl", hash = "sha256:3bb2b7a1f7b685f85b11fed1ef10f8a9148bceb49853e47a294a3dd963c1dd7d"},
31 | {file = "black-24.10.0.tar.gz", hash = "sha256:846ea64c97afe3bc677b761787993be4991810ecc7a4a937816dd6bddedc4875"},
32 | ]
33 |
34 | [package.dependencies]
35 | click = ">=8.0.0"
36 | mypy-extensions = ">=0.4.3"
37 | packaging = ">=22.0"
38 | pathspec = ">=0.9.0"
39 | platformdirs = ">=2"
40 | tomli = {version = ">=1.1.0", markers = "python_version < \"3.11\""}
41 | typing-extensions = {version = ">=4.0.1", markers = "python_version < \"3.11\""}
42 |
43 | [package.extras]
44 | colorama = ["colorama (>=0.4.3)"]
45 | d = ["aiohttp (>=3.10)"]
46 | jupyter = ["ipython (>=7.8.0)", "tokenize-rt (>=3.2.0)"]
47 | uvloop = ["uvloop (>=0.15.2)"]
48 |
49 | [[package]]
50 | name = "click"
51 | version = "8.1.7"
52 | description = "Composable command line interface toolkit"
53 | optional = false
54 | python-versions = ">=3.7"
55 | files = [
56 | {file = "click-8.1.7-py3-none-any.whl", hash = "sha256:ae74fb96c20a0277a1d615f1e4d73c8414f5a98db8b799a7931d1582f3390c28"},
57 | {file = "click-8.1.7.tar.gz", hash = "sha256:ca9853ad459e787e2192211578cc907e7594e294c7ccc834310722b41b9ca6de"},
58 | ]
59 |
60 | [package.dependencies]
61 | colorama = {version = "*", markers = "platform_system == \"Windows\""}
62 |
63 | [[package]]
64 | name = "colorama"
65 | version = "0.4.6"
66 | description = "Cross-platform colored terminal text."
67 | optional = false
68 | python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
69 | files = [
70 | {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
71 | {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
72 | ]
73 |
74 | [[package]]
75 | name = "grpcio"
76 | version = "1.67.0"
77 | description = "HTTP/2-based RPC framework"
78 | optional = false
79 | python-versions = ">=3.8"
80 | files = [
81 | {file = "grpcio-1.67.0-cp310-cp310-linux_armv7l.whl", hash = "sha256:bd79929b3bb96b54df1296cd3bf4d2b770bd1df6c2bdf549b49bab286b925cdc"},
82 | {file = "grpcio-1.67.0-cp310-cp310-macosx_12_0_universal2.whl", hash = "sha256:16724ffc956ea42967f5758c2f043faef43cb7e48a51948ab593570570d1e68b"},
83 | {file = "grpcio-1.67.0-cp310-cp310-manylinux_2_17_aarch64.whl", hash = "sha256:2b7183c80b602b0ad816315d66f2fb7887614ead950416d60913a9a71c12560d"},
84 | {file = "grpcio-1.67.0-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:efe32b45dd6d118f5ea2e5deaed417d8a14976325c93812dd831908522b402c9"},
85 | {file = "grpcio-1.67.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fe89295219b9c9e47780a0f1c75ca44211e706d1c598242249fe717af3385ec8"},
86 | {file = "grpcio-1.67.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:aa8d025fae1595a207b4e47c2e087cb88d47008494db258ac561c00877d4c8f8"},
87 | {file = "grpcio-1.67.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:f95e15db43e75a534420e04822df91f645664bf4ad21dfaad7d51773c80e6bb4"},
88 | {file = "grpcio-1.67.0-cp310-cp310-win32.whl", hash = "sha256:a6b9a5c18863fd4b6624a42e2712103fb0f57799a3b29651c0e5b8119a519d65"},
89 | {file = "grpcio-1.67.0-cp310-cp310-win_amd64.whl", hash = "sha256:b6eb68493a05d38b426604e1dc93bfc0137c4157f7ab4fac5771fd9a104bbaa6"},
90 | {file = "grpcio-1.67.0-cp311-cp311-linux_armv7l.whl", hash = "sha256:e91d154689639932305b6ea6f45c6e46bb51ecc8ea77c10ef25aa77f75443ad4"},
91 | {file = "grpcio-1.67.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:cb204a742997277da678611a809a8409657b1398aaeebf73b3d9563b7d154c13"},
92 | {file = "grpcio-1.67.0-cp311-cp311-manylinux_2_17_aarch64.whl", hash = "sha256:ae6de510f670137e755eb2a74b04d1041e7210af2444103c8c95f193340d17ee"},
93 | {file = "grpcio-1.67.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:74b900566bdf68241118f2918d312d3bf554b2ce0b12b90178091ea7d0a17b3d"},
94 | {file = "grpcio-1.67.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:a4e95e43447a02aa603abcc6b5e727d093d161a869c83b073f50b9390ecf0fa8"},
95 | {file = "grpcio-1.67.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:0bb94e66cd8f0baf29bd3184b6aa09aeb1a660f9ec3d85da615c5003154bc2bf"},
96 | {file = "grpcio-1.67.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:82e5bd4b67b17c8c597273663794a6a46a45e44165b960517fe6d8a2f7f16d23"},
97 | {file = "grpcio-1.67.0-cp311-cp311-win32.whl", hash = "sha256:7fc1d2b9fd549264ae585026b266ac2db53735510a207381be509c315b4af4e8"},
98 | {file = "grpcio-1.67.0-cp311-cp311-win_amd64.whl", hash = "sha256:ac11ecb34a86b831239cc38245403a8de25037b448464f95c3315819e7519772"},
99 | {file = "grpcio-1.67.0-cp312-cp312-linux_armv7l.whl", hash = "sha256:227316b5631260e0bef8a3ce04fa7db4cc81756fea1258b007950b6efc90c05d"},
100 | {file = "grpcio-1.67.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:d90cfdafcf4b45a7a076e3e2a58e7bc3d59c698c4f6470b0bb13a4d869cf2273"},
101 | {file = "grpcio-1.67.0-cp312-cp312-manylinux_2_17_aarch64.whl", hash = "sha256:77196216d5dd6f99af1c51e235af2dd339159f657280e65ce7e12c1a8feffd1d"},
102 | {file = "grpcio-1.67.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:15c05a26a0f7047f720da41dc49406b395c1470eef44ff7e2c506a47ac2c0591"},
103 | {file = "grpcio-1.67.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3840994689cc8cbb73d60485c594424ad8adb56c71a30d8948d6453083624b52"},
104 | {file = "grpcio-1.67.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:5a1e03c3102b6451028d5dc9f8591131d6ab3c8a0e023d94c28cb930ed4b5f81"},
105 | {file = "grpcio-1.67.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:682968427a63d898759474e3b3178d42546e878fdce034fd7474ef75143b64e3"},
106 | {file = "grpcio-1.67.0-cp312-cp312-win32.whl", hash = "sha256:d01793653248f49cf47e5695e0a79805b1d9d4eacef85b310118ba1dfcd1b955"},
107 | {file = "grpcio-1.67.0-cp312-cp312-win_amd64.whl", hash = "sha256:985b2686f786f3e20326c4367eebdaed3e7aa65848260ff0c6644f817042cb15"},
108 | {file = "grpcio-1.67.0-cp313-cp313-linux_armv7l.whl", hash = "sha256:8c9a35b8bc50db35ab8e3e02a4f2a35cfba46c8705c3911c34ce343bd777813a"},
109 | {file = "grpcio-1.67.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:42199e704095b62688998c2d84c89e59a26a7d5d32eed86d43dc90e7a3bd04aa"},
110 | {file = "grpcio-1.67.0-cp313-cp313-manylinux_2_17_aarch64.whl", hash = "sha256:c4c425f440fb81f8d0237c07b9322fc0fb6ee2b29fbef5f62a322ff8fcce240d"},
111 | {file = "grpcio-1.67.0-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:323741b6699cd2b04a71cb38f502db98f90532e8a40cb675393d248126a268af"},
112 | {file = "grpcio-1.67.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:662c8e105c5e5cee0317d500eb186ed7a93229586e431c1bf0c9236c2407352c"},
113 | {file = "grpcio-1.67.0-cp313-cp313-musllinux_1_1_i686.whl", hash = "sha256:f6bd2ab135c64a4d1e9e44679a616c9bc944547357c830fafea5c3caa3de5153"},
114 | {file = "grpcio-1.67.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:2f55c1e0e2ae9bdd23b3c63459ee4c06d223b68aeb1961d83c48fb63dc29bc03"},
115 | {file = "grpcio-1.67.0-cp313-cp313-win32.whl", hash = "sha256:fd6bc27861e460fe28e94226e3673d46e294ca4673d46b224428d197c5935e69"},
116 | {file = "grpcio-1.67.0-cp313-cp313-win_amd64.whl", hash = "sha256:cf51d28063338608cd8d3cd64677e922134837902b70ce00dad7f116e3998210"},
117 | {file = "grpcio-1.67.0-cp38-cp38-linux_armv7l.whl", hash = "sha256:7f200aca719c1c5dc72ab68be3479b9dafccdf03df530d137632c534bb6f1ee3"},
118 | {file = "grpcio-1.67.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:0892dd200ece4822d72dd0952f7112c542a487fc48fe77568deaaa399c1e717d"},
119 | {file = "grpcio-1.67.0-cp38-cp38-manylinux_2_17_aarch64.whl", hash = "sha256:f4d613fbf868b2e2444f490d18af472ccb47660ea3df52f068c9c8801e1f3e85"},
120 | {file = "grpcio-1.67.0-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:0c69bf11894cad9da00047f46584d5758d6ebc9b5950c0dc96fec7e0bce5cde9"},
121 | {file = "grpcio-1.67.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b9bca3ca0c5e74dea44bf57d27e15a3a3996ce7e5780d61b7c72386356d231db"},
122 | {file = "grpcio-1.67.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:014dfc020e28a0d9be7e93a91f85ff9f4a87158b7df9952fe23cc42d29d31e1e"},
123 | {file = "grpcio-1.67.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:d4ea4509d42c6797539e9ec7496c15473177ce9abc89bc5c71e7abe50fc25737"},
124 | {file = "grpcio-1.67.0-cp38-cp38-win32.whl", hash = "sha256:9d75641a2fca9ae1ae86454fd25d4c298ea8cc195dbc962852234d54a07060ad"},
125 | {file = "grpcio-1.67.0-cp38-cp38-win_amd64.whl", hash = "sha256:cff8e54d6a463883cda2fab94d2062aad2f5edd7f06ae3ed030f2a74756db365"},
126 | {file = "grpcio-1.67.0-cp39-cp39-linux_armv7l.whl", hash = "sha256:62492bd534979e6d7127b8a6b29093161a742dee3875873e01964049d5250a74"},
127 | {file = "grpcio-1.67.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:eef1dce9d1a46119fd09f9a992cf6ab9d9178b696382439446ca5f399d7b96fe"},
128 | {file = "grpcio-1.67.0-cp39-cp39-manylinux_2_17_aarch64.whl", hash = "sha256:f623c57a5321461c84498a99dddf9d13dac0e40ee056d884d6ec4ebcab647a78"},
129 | {file = "grpcio-1.67.0-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:54d16383044e681f8beb50f905249e4e7261dd169d4aaf6e52eab67b01cbbbe2"},
130 | {file = "grpcio-1.67.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:b2a44e572fb762c668e4812156b81835f7aba8a721b027e2d4bb29fb50ff4d33"},
131 | {file = "grpcio-1.67.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:391df8b0faac84d42f5b8dfc65f5152c48ed914e13c522fd05f2aca211f8bfad"},
132 | {file = "grpcio-1.67.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:cfd9306511fdfc623a1ba1dc3bc07fbd24e6cfbe3c28b4d1e05177baa2f99617"},
133 | {file = "grpcio-1.67.0-cp39-cp39-win32.whl", hash = "sha256:30d47dbacfd20cbd0c8be9bfa52fdb833b395d4ec32fe5cff7220afc05d08571"},
134 | {file = "grpcio-1.67.0-cp39-cp39-win_amd64.whl", hash = "sha256:f55f077685f61f0fbd06ea355142b71e47e4a26d2d678b3ba27248abfe67163a"},
135 | {file = "grpcio-1.67.0.tar.gz", hash = "sha256:e090b2553e0da1c875449c8e75073dd4415dd71c9bde6a406240fdf4c0ee467c"},
136 | ]
137 |
138 | [package.extras]
139 | protobuf = ["grpcio-tools (>=1.67.0)"]
140 |
141 | [[package]]
142 | name = "grpcio-tools"
143 | version = "1.67.0"
144 | description = "Protobuf code generator for gRPC"
145 | optional = false
146 | python-versions = ">=3.8"
147 | files = [
148 | {file = "grpcio_tools-1.67.0-cp310-cp310-linux_armv7l.whl", hash = "sha256:12aa38af76b5ef00a55808c7c374ed18d5dc7cc8081b717e56da3c50df1776e2"},
149 | {file = "grpcio_tools-1.67.0-cp310-cp310-macosx_12_0_universal2.whl", hash = "sha256:b0b03d055127bbc7c629454804b53b5cad2cedfcf904576d159a8a04c22b8e66"},
150 | {file = "grpcio_tools-1.67.0-cp310-cp310-manylinux_2_17_aarch64.whl", hash = "sha256:02b0b50c59a8f7428326197027a2f586d216c46138c547f861533c46bff78bfe"},
151 | {file = "grpcio_tools-1.67.0-cp310-cp310-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:b2afdfe151ed9edbd4a3fd646716f83b58010769c57f9c0aa1cf4c3bfb1240a8"},
152 | {file = "grpcio_tools-1.67.0-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:fc3eeb87575b2b360c5ef5aef22eb76cfdd6a255d2f628a48ab0e5a61a0039fb"},
153 | {file = "grpcio_tools-1.67.0-cp310-cp310-musllinux_1_1_i686.whl", hash = "sha256:ead78089c4771605a1ff8894e47f2267440693f1beeee06fd5a788aede83370f"},
154 | {file = "grpcio_tools-1.67.0-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:0671dcdccef09ca4eb415c1d6f470a857c6486733c146676f6810a3ade1d42cb"},
155 | {file = "grpcio_tools-1.67.0-cp310-cp310-win32.whl", hash = "sha256:a7398d90b8c7da479aec8f853d3664d5a93c209f8ac3bd41cb7ae4e8677a45c6"},
156 | {file = "grpcio_tools-1.67.0-cp310-cp310-win_amd64.whl", hash = "sha256:f7e7d70a74df7e07be7cceaa694b7e8e5f3bef8e0299906f60885ecf7a40adb4"},
157 | {file = "grpcio_tools-1.67.0-cp311-cp311-linux_armv7l.whl", hash = "sha256:655716bf931a22a090134d87953710033640996d31e36f5f9b0106ff5f552d8e"},
158 | {file = "grpcio_tools-1.67.0-cp311-cp311-macosx_10_9_universal2.whl", hash = "sha256:484ae782f9d3ff58e0bbb2f4cad14d5f5d9132fc701835b1dffd2c2a06f73ba6"},
159 | {file = "grpcio_tools-1.67.0-cp311-cp311-manylinux_2_17_aarch64.whl", hash = "sha256:f3e34de876efe1273f91e25ef241e449ed7f9411472dd9ff56d2039618017c30"},
160 | {file = "grpcio_tools-1.67.0-cp311-cp311-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:d8301719edde2c3d388995703cdd962f558b76e9750405f772dce61402e4c3d0"},
161 | {file = "grpcio_tools-1.67.0-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1629ea246044ccd473d9ac4c9f137a440d830b5e08d35225e1b354dbbb15b75d"},
162 | {file = "grpcio_tools-1.67.0-cp311-cp311-musllinux_1_1_i686.whl", hash = "sha256:d77a3c5cec0065267ca1a0b2589ececd1277ce25aa67f13ec50c816ee6f26f7f"},
163 | {file = "grpcio_tools-1.67.0-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:c9bf992bcc7d9e6eaa20705056e1b955593092a38cec1746fef389d873ab2056"},
164 | {file = "grpcio_tools-1.67.0-cp311-cp311-win32.whl", hash = "sha256:7e6e3db119c38629e0767cdb2ee18726ecc87e2249117d4c9e7ce06ea8c894ea"},
165 | {file = "grpcio_tools-1.67.0-cp311-cp311-win_amd64.whl", hash = "sha256:c6c27aec301a0e6cf231f9ee1c467c64002af51170fa7c0f3bb10bbfcd03fee7"},
166 | {file = "grpcio_tools-1.67.0-cp312-cp312-linux_armv7l.whl", hash = "sha256:dca7f053cbdb26a587d4410ddb893877c585fb60a31f22fdd128e4f7c4dab27c"},
167 | {file = "grpcio_tools-1.67.0-cp312-cp312-macosx_10_9_universal2.whl", hash = "sha256:de8c4f68ffa690769d84329c17c7fdd5fbe4c61b8f8a0de03f1ad8ef8bb06963"},
168 | {file = "grpcio_tools-1.67.0-cp312-cp312-manylinux_2_17_aarch64.whl", hash = "sha256:6e4ecb24c27a78f09fead45d4ed873805d6026124ccb6793b6fb93a490b78ddf"},
169 | {file = "grpcio_tools-1.67.0-cp312-cp312-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:004d6ef1b5f724480f05c0bdc904bf8c78c43d633c537d99abe51b52ce0cadeb"},
170 | {file = "grpcio_tools-1.67.0-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9dd257072c86eb9b36791b3674a513a215ba76bbdd38fc228f0e8c6dc5ce3524"},
171 | {file = "grpcio_tools-1.67.0-cp312-cp312-musllinux_1_1_i686.whl", hash = "sha256:a8cca551317ed26e17d13b6ee27b2bd62f5fe9b3842b4e88389deb984f995848"},
172 | {file = "grpcio_tools-1.67.0-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a7ac3b4f837c693142f6688b629d1f6408f6ab250d927159b572555f5339fe25"},
173 | {file = "grpcio_tools-1.67.0-cp312-cp312-win32.whl", hash = "sha256:95feec33388e2a8f72c360a68efe6f0bfed9c771e94d21b7f2359d0010f60219"},
174 | {file = "grpcio_tools-1.67.0-cp312-cp312-win_amd64.whl", hash = "sha256:50a31d035193ebe7154181eac84734e25bdcdb36adba849d3b2adf1c3b0c382b"},
175 | {file = "grpcio_tools-1.67.0-cp313-cp313-linux_armv7l.whl", hash = "sha256:9ecb7c2e5da052a3feaeaa83d8f2a946a8feec8a50751b0e6175da982b49ebb1"},
176 | {file = "grpcio_tools-1.67.0-cp313-cp313-macosx_10_13_universal2.whl", hash = "sha256:3c52164f2b9d41c6d75464bb45f45737dcb421e92e98d85d94fda100c67a24d8"},
177 | {file = "grpcio_tools-1.67.0-cp313-cp313-manylinux_2_17_aarch64.whl", hash = "sha256:471f58b919767290260d427dd9b760796e6208ee5fcda2f76bb8bd585ff842ec"},
178 | {file = "grpcio_tools-1.67.0-cp313-cp313-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:72c6bcdf38f672721c093c92b1fb1f9a02a365acc5bd42e1c69fe6e904b26081"},
179 | {file = "grpcio_tools-1.67.0-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:833b1eb9c03d28a798294523f75294055eff78fa897adf797876337b901afeb9"},
180 | {file = "grpcio_tools-1.67.0-cp313-cp313-musllinux_1_1_i686.whl", hash = "sha256:1db92ad6ade1946fc5705eb04956fcfdb3a0a4682de8dc3fce31cb97b6e4fcb8"},
181 | {file = "grpcio_tools-1.67.0-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:38128310ded818e1044c0cd0979d76f7c0d3c3946a526a8aa39cd258624c3bf3"},
182 | {file = "grpcio_tools-1.67.0-cp313-cp313-win32.whl", hash = "sha256:db57930dc20ab678311727883bdb9f122daf06c14f3fd3067c9ccedb7eb056c3"},
183 | {file = "grpcio_tools-1.67.0-cp313-cp313-win_amd64.whl", hash = "sha256:7de44d8d3bb920a4973a559f2950d03382fa4aed4880306416ffa73d24838477"},
184 | {file = "grpcio_tools-1.67.0-cp38-cp38-linux_armv7l.whl", hash = "sha256:793896648734aad3ad8f26795dcdd6040aecd35efef43fcbb67d221373e6379a"},
185 | {file = "grpcio_tools-1.67.0-cp38-cp38-macosx_10_9_universal2.whl", hash = "sha256:941418cba6a8adfcac3ff7ff3bdef00b55a44d673634c15bddcfa7778e49239e"},
186 | {file = "grpcio_tools-1.67.0-cp38-cp38-manylinux_2_17_aarch64.whl", hash = "sha256:0d63ff6be6f3d0294249fc7a21f26f06c9cc209130c5328907cd678406d7d232"},
187 | {file = "grpcio_tools-1.67.0-cp38-cp38-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:af80ced3ba49377ef7bec93e9ccbfa357875460e9a624ed12d9a7d5348741a76"},
188 | {file = "grpcio_tools-1.67.0-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:e3c3fbb4a6d10764295540579492397bc7a3334e1a92dd17a4bc7b69159cf70a"},
189 | {file = "grpcio_tools-1.67.0-cp38-cp38-musllinux_1_1_i686.whl", hash = "sha256:a05c10fb783f609d16e1f754ebad9bb432a1adbfc46139d154e8fd6b15f59988"},
190 | {file = "grpcio_tools-1.67.0-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:ea8af001f08c678ab59e2bf2614d8b09d62210e540f7af1129c172fe4fd330c7"},
191 | {file = "grpcio_tools-1.67.0-cp38-cp38-win32.whl", hash = "sha256:004d329aee385fa874979196e5359a967c370d31813f61eba88043ccaa2e06d8"},
192 | {file = "grpcio_tools-1.67.0-cp38-cp38-win_amd64.whl", hash = "sha256:fc43593bd051abb73a5d130fc041923144089ac459fb01165960106ebb686fd0"},
193 | {file = "grpcio_tools-1.67.0-cp39-cp39-linux_armv7l.whl", hash = "sha256:d285c036ddfc2618c4db60b584409dd8313d41473bd46177c763ea22ed9aeb1f"},
194 | {file = "grpcio_tools-1.67.0-cp39-cp39-macosx_10_9_universal2.whl", hash = "sha256:623fdad489447e1565d0ba5a818d54b4e74cd73800b6a32c4c009601c7f7a36c"},
195 | {file = "grpcio_tools-1.67.0-cp39-cp39-manylinux_2_17_aarch64.whl", hash = "sha256:24536af8a5f8e532fbd996c1763eff51526d1d1563f9499ff5ffffb9a08811f3"},
196 | {file = "grpcio_tools-1.67.0-cp39-cp39-manylinux_2_17_i686.manylinux2014_i686.whl", hash = "sha256:bd64a9a8eb675dd2aa59cb4b2ab025a3b02ae1bb9e483c7fb518ffa0f0755cda"},
197 | {file = "grpcio_tools-1.67.0-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:f94378bc90fb008b0a56237748aa42c787fd86c392e7df3d65f0fe7fcd93844a"},
198 | {file = "grpcio_tools-1.67.0-cp39-cp39-musllinux_1_1_i686.whl", hash = "sha256:d0f39a9d860a6768574cd77b5d9ad81513fa1c575d3a050d4e72e6d79dcd62f3"},
199 | {file = "grpcio_tools-1.67.0-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:c578f1306bfd0dd0668e24f8c04d61529928de2660217022a947a56be177bc2d"},
200 | {file = "grpcio_tools-1.67.0-cp39-cp39-win32.whl", hash = "sha256:0c2cf8d09bdc05e0550ad413e0bc0d552500bb7f98d36079b7b9d38e064e02f7"},
201 | {file = "grpcio_tools-1.67.0-cp39-cp39-win_amd64.whl", hash = "sha256:cc570bcd9c9681bb011f746ea90cc50559be629227aaaaae9fde8549525f0287"},
202 | {file = "grpcio_tools-1.67.0.tar.gz", hash = "sha256:181b3d4e61b83142c182ec366f3079b0023509743986e54c9465ca38cac255f8"},
203 | ]
204 |
205 | [package.dependencies]
206 | grpcio = ">=1.67.0"
207 | protobuf = ">=5.26.1,<6.0dev"
208 | setuptools = "*"
209 |
210 | [[package]]
211 | name = "mypy-extensions"
212 | version = "1.0.0"
213 | description = "Type system extensions for programs checked with the mypy type checker."
214 | optional = false
215 | python-versions = ">=3.5"
216 | files = [
217 | {file = "mypy_extensions-1.0.0-py3-none-any.whl", hash = "sha256:4392f6c0eb8a5668a69e23d168ffa70f0be9ccfd32b5cc2d26a34ae5b844552d"},
218 | {file = "mypy_extensions-1.0.0.tar.gz", hash = "sha256:75dbf8955dc00442a438fc4d0666508a9a97b6bd41aa2f0ffe9d2f2725af0782"},
219 | ]
220 |
221 | [[package]]
222 | name = "packaging"
223 | version = "24.1"
224 | description = "Core utilities for Python packages"
225 | optional = false
226 | python-versions = ">=3.8"
227 | files = [
228 | {file = "packaging-24.1-py3-none-any.whl", hash = "sha256:5b8f2217dbdbd2f7f384c41c628544e6d52f2d0f53c6d0c3ea61aa5d1d7ff124"},
229 | {file = "packaging-24.1.tar.gz", hash = "sha256:026ed72c8ed3fcce5bf8950572258698927fd1dbda10a5e981cdf0ac37f4f002"},
230 | ]
231 |
232 | [[package]]
233 | name = "pathspec"
234 | version = "0.12.1"
235 | description = "Utility library for gitignore style pattern matching of file paths."
236 | optional = false
237 | python-versions = ">=3.8"
238 | files = [
239 | {file = "pathspec-0.12.1-py3-none-any.whl", hash = "sha256:a0d503e138a4c123b27490a4f7beda6a01c6f288df0e4a8b79c7eb0dc7b4cc08"},
240 | {file = "pathspec-0.12.1.tar.gz", hash = "sha256:a482d51503a1ab33b1c67a6c3813a26953dbdc71c31dacaef9a838c4e29f5712"},
241 | ]
242 |
243 | [[package]]
244 | name = "platformdirs"
245 | version = "4.3.6"
246 | description = "A small Python package for determining appropriate platform-specific dirs, e.g. a `user data dir`."
247 | optional = false
248 | python-versions = ">=3.8"
249 | files = [
250 | {file = "platformdirs-4.3.6-py3-none-any.whl", hash = "sha256:73e575e1408ab8103900836b97580d5307456908a03e92031bab39e4554cc3fb"},
251 | {file = "platformdirs-4.3.6.tar.gz", hash = "sha256:357fb2acbc885b0419afd3ce3ed34564c13c9b95c89360cd9563f73aa5e2b907"},
252 | ]
253 |
254 | [package.extras]
255 | docs = ["furo (>=2024.8.6)", "proselint (>=0.14)", "sphinx (>=8.0.2)", "sphinx-autodoc-typehints (>=2.4)"]
256 | test = ["appdirs (==1.4.4)", "covdefaults (>=2.3)", "pytest (>=8.3.2)", "pytest-cov (>=5)", "pytest-mock (>=3.14)"]
257 | type = ["mypy (>=1.11.2)"]
258 |
259 | [[package]]
260 | name = "protobuf"
261 | version = "5.28.2"
262 | description = ""
263 | optional = false
264 | python-versions = ">=3.8"
265 | files = [
266 | {file = "protobuf-5.28.2-cp310-abi3-win32.whl", hash = "sha256:eeea10f3dc0ac7e6b4933d32db20662902b4ab81bf28df12218aa389e9c2102d"},
267 | {file = "protobuf-5.28.2-cp310-abi3-win_amd64.whl", hash = "sha256:2c69461a7fcc8e24be697624c09a839976d82ae75062b11a0972e41fd2cd9132"},
268 | {file = "protobuf-5.28.2-cp38-abi3-macosx_10_9_universal2.whl", hash = "sha256:a8b9403fc70764b08d2f593ce44f1d2920c5077bf7d311fefec999f8c40f78b7"},
269 | {file = "protobuf-5.28.2-cp38-abi3-manylinux2014_aarch64.whl", hash = "sha256:35cfcb15f213449af7ff6198d6eb5f739c37d7e4f1c09b5d0641babf2cc0c68f"},
270 | {file = "protobuf-5.28.2-cp38-abi3-manylinux2014_x86_64.whl", hash = "sha256:5e8a95246d581eef20471b5d5ba010d55f66740942b95ba9b872d918c459452f"},
271 | {file = "protobuf-5.28.2-cp38-cp38-win32.whl", hash = "sha256:87317e9bcda04a32f2ee82089a204d3a2f0d3c8aeed16568c7daf4756e4f1fe0"},
272 | {file = "protobuf-5.28.2-cp38-cp38-win_amd64.whl", hash = "sha256:c0ea0123dac3399a2eeb1a1443d82b7afc9ff40241433296769f7da42d142ec3"},
273 | {file = "protobuf-5.28.2-cp39-cp39-win32.whl", hash = "sha256:ca53faf29896c526863366a52a8f4d88e69cd04ec9571ed6082fa117fac3ab36"},
274 | {file = "protobuf-5.28.2-cp39-cp39-win_amd64.whl", hash = "sha256:8ddc60bf374785fb7cb12510b267f59067fa10087325b8e1855b898a0d81d276"},
275 | {file = "protobuf-5.28.2-py3-none-any.whl", hash = "sha256:52235802093bd8a2811abbe8bf0ab9c5f54cca0a751fdd3f6ac2a21438bffece"},
276 | {file = "protobuf-5.28.2.tar.gz", hash = "sha256:59379674ff119717404f7454647913787034f03fe7049cbef1d74a97bb4593f0"},
277 | ]
278 |
279 | [[package]]
280 | name = "setuptools"
281 | version = "75.2.0"
282 | description = "Easily download, build, install, upgrade, and uninstall Python packages"
283 | optional = false
284 | python-versions = ">=3.8"
285 | files = [
286 | {file = "setuptools-75.2.0-py3-none-any.whl", hash = "sha256:a7fcb66f68b4d9e8e66b42f9876150a3371558f98fa32222ffaa5bced76406f8"},
287 | {file = "setuptools-75.2.0.tar.gz", hash = "sha256:753bb6ebf1f465a1912e19ed1d41f403a79173a9acf66a42e7e6aec45c3c16ec"},
288 | ]
289 |
290 | [package.extras]
291 | check = ["pytest-checkdocs (>=2.4)", "pytest-ruff (>=0.2.1)", "ruff (>=0.5.2)"]
292 | core = ["importlib-metadata (>=6)", "importlib-resources (>=5.10.2)", "jaraco.collections", "jaraco.functools", "jaraco.text (>=3.7)", "more-itertools", "more-itertools (>=8.8)", "packaging", "packaging (>=24)", "platformdirs (>=2.6.2)", "tomli (>=2.0.1)", "wheel (>=0.43.0)"]
293 | cover = ["pytest-cov"]
294 | doc = ["furo", "jaraco.packaging (>=9.3)", "jaraco.tidelift (>=1.4)", "pygments-github-lexers (==0.0.5)", "pyproject-hooks (!=1.1)", "rst.linker (>=1.9)", "sphinx (>=3.5)", "sphinx-favicon", "sphinx-inline-tabs", "sphinx-lint", "sphinx-notfound-page (>=1,<2)", "sphinx-reredirects", "sphinxcontrib-towncrier", "towncrier (<24.7)"]
295 | enabler = ["pytest-enabler (>=2.2)"]
296 | test = ["build[virtualenv] (>=1.0.3)", "filelock (>=3.4.0)", "ini2toml[lite] (>=0.14)", "jaraco.develop (>=7.21)", "jaraco.envs (>=2.2)", "jaraco.path (>=3.2.0)", "jaraco.test", "packaging (>=23.2)", "pip (>=19.1)", "pyproject-hooks (!=1.1)", "pytest (>=6,!=8.1.*)", "pytest-home (>=0.5)", "pytest-perf", "pytest-subprocess", "pytest-timeout", "pytest-xdist (>=3)", "tomli-w (>=1.0.0)", "virtualenv (>=13.0.0)", "wheel (>=0.44.0)"]
297 | type = ["importlib-metadata (>=7.0.2)", "jaraco.develop (>=7.21)", "mypy (==1.11.*)", "pytest-mypy"]
298 |
299 | [[package]]
300 | name = "tomli"
301 | version = "2.0.2"
302 | description = "A lil' TOML parser"
303 | optional = false
304 | python-versions = ">=3.8"
305 | files = [
306 | {file = "tomli-2.0.2-py3-none-any.whl", hash = "sha256:2ebe24485c53d303f690b0ec092806a085f07af5a5aa1464f3931eec36caaa38"},
307 | {file = "tomli-2.0.2.tar.gz", hash = "sha256:d46d457a85337051c36524bc5349dd91b1877838e2979ac5ced3e710ed8a60ed"},
308 | ]
309 |
310 | [[package]]
311 | name = "typing-extensions"
312 | version = "4.12.2"
313 | description = "Backported and Experimental Type Hints for Python 3.8+"
314 | optional = false
315 | python-versions = ">=3.8"
316 | files = [
317 | {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
318 | {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
319 | ]
320 |
321 | [metadata]
322 | lock-version = "2.0"
323 | python-versions = "^3.10"
324 | content-hash = "0ee0d0ccb96cc119661839054c1a6f7737c0fbf7d540f4dcea44c668f1d3f73f"
325 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 3, 29 June 2007
3 |
4 | Copyright (C) 2007 Free Software Foundation, Inc.
635 | Copyright (C)
636 |
637 | This program is free software: you can redistribute it and/or modify
638 | it under the terms of the GNU General Public License as published by
639 | the Free Software Foundation, either version 3 of the License, or
640 | (at your option) any later version.
641 |
642 | This program is distributed in the hope that it will be useful,
643 | but WITHOUT ANY WARRANTY; without even the implied warranty of
644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
645 | GNU General Public License for more details.
646 |
647 | You should have received a copy of the GNU General Public License
648 | along with this program. If not, see Copyright (C)
656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
657 | This is free software, and you are welcome to redistribute it
658 | under certain conditions; type `show c' for details.
659 |
660 | The hypothetical commands `show w' and `show c' should show the appropriate
661 | parts of the General Public License. Of course, your program's commands
662 | might be different; for a GUI interface, you would use an "about box".
663 |
664 | You should also get your employer (if you work as a programmer) or school,
665 | if any, to sign a "copyright disclaimer" for the program, if necessary.
666 | For more information on this, and how to apply and follow the GNU GPL, see
667 | .
675 |
--------------------------------------------------------------------------------
{
13 | show = false
14 | }}
15 | />
16 |
20 | {/if}
21 |
22 |
44 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/utils/tooltip.svelte:
--------------------------------------------------------------------------------
1 |
18 |
19 | {#if show && content}
20 |
17 |
19 |
21 |
25 | {/if}
26 |
27 |
38 |
--------------------------------------------------------------------------------
/clients/.note:
--------------------------------------------------------------------------------
1 | This repository contains multiple projects of Phantasm client libraries.
2 | Each directory contains a separate project for different programming
3 | languages represented by the directory name.
4 |
5 | Each project must have their own README.md file with the following sections:
6 | - Badges
7 | - Project Banner
8 | - Get Started
9 |
10 | The project banner can be retrieved from the root README.md file. The Get
11 | Started section must contain a minimum reproducible example of how to use
12 | the library.
13 |
14 | Design
15 |
16 | Phantasm client libraries should be simple and consistent across all
17 | programming languages. With that in mind, each library should have a single
18 | class or similar construct called "Phantasm" which will be the main entry
19 | point for the library.
20 |
21 | The Phantasm class should have the methods listed in the receiver.proto file.
22 | Optionally, the Phantasm class can have additional methods that are specific
23 | to the programming language aimed at making the library easier to use such as
24 | decorators in Python or macros in Rust.
25 |
--------------------------------------------------------------------------------
/clients/python/pyproject.toml:
--------------------------------------------------------------------------------
1 | [tool.poetry]
2 | name = "phantasmpy"
3 | version = "0.1.3"
4 | description = "A Python client to interact with Phantasm's receiver server."
5 | license = "MIT"
6 | repository = "https://github.com/phantasmlabs/phantasm"
7 | readme = "README.md"
8 | authors = ["Edwin Kys
22 | {content}
23 |
24 |
13 |
27 |
28 |
60 |
--------------------------------------------------------------------------------
/docs/docs/configuration.md:
--------------------------------------------------------------------------------
1 | # Configuration
2 |
3 | Phantasm starts with a sensible default configuration that you can override
4 | either by setting environment variables or by passing command-line arguments.
5 | This documentation will guide you through the available configuration options.
6 |
7 | ## Receiver Authentication
8 |
9 | Phantasm allows you to configure authentication for the communication between
10 | the client and the Receiver Server. Phantasm uses a simple secret key mechanism
11 | to authenticate the client, and by default, authentication is disabled.
12 |
13 | To enable authentication, simply set the `PHANTASM_SECRET` environment variable
14 | to your secret key before starting the server. If you are running Phantasm in a
15 | Docker container, this is how you can set the secret key:
16 |
17 | ```bash
18 | docker run -e PHANTASM_SECRET=secretkey ...
19 | ```
20 |
21 | When authentication is enabled, you must provide the secret key when
22 | initializing the client to ensure that the client can authenticate and
23 | communicate with the Receiver Server.
24 |
25 | === "Python"
26 |
27 | ```python
28 | from phantasmpy import Phantasm
29 | phantasm = Phantasm(secret="secretkey")
30 | ```
31 |
32 | ## Auto Approval
33 |
34 | There are times when an approver is not available to approve an action call. By
35 | default, Phantasm will return an error response with unavailable status code. If
36 | you want to automatically approve all actions when no approver is available, you
37 | can enable the auto-approval feature by setting the `PHANTASM_AUTO_APPROVAL`
38 | environment variable to true.
39 |
40 | ```bash
41 | docker run -e PHANTASM_AUTO_APPROVAL=true ...
42 | ```
43 |
44 | !!! warning
45 |
46 | Enabling auto-approval is not recommended for production environments.
47 |
--------------------------------------------------------------------------------
/docs/index.md:
--------------------------------------------------------------------------------
1 | # Introducing Phantasm
2 |
3 | 
4 |
5 | Thank you for considering using Phantasm. Phantasm is a simple human-in-the-loop
6 | (HITL) approval layer for AI agents. With Phantasm, you can build and deploy AI
7 | agents that can execute critical business tasks safely.
8 |
9 | Most of the information you need to get started can be found in the
10 | [Repository][repo]. This documentation, instead, will focus on explaining the
11 | details and concepts in the project. If you have any questions or need help,
12 | please feel free to reach out to us on [Discord][discord].
13 |
14 | [repo]: https://github.com/phantasmlabs/phantasm
15 | [discord]: https://discord.gg/dgevsYhh7P
16 |
17 | ## Components
18 |
19 | Phantasm consists of 3 main components: Client, Server, and Dashboard.
20 |
21 | ### Server
22 |
23 | The server is the primary component that connects the client and the dashboard.
24 | The server responsible for receiving the approval requests from the client is
25 | called the _Receiver Server_ and the server responsible for coordinating the
26 | approval requests with the dashboard is called the _Coordinator Server_.
27 |
28 | The _Receiver Server_ uses gRPC while the _Coordinator Server_ uses WebSocket
29 | protocol. Both servers are written in Rust and are controlled by Phantasm's CLI.
30 | If you're using Docker, this CLI is already the primary entry point for the
31 | image.
32 |
33 | ### Client
34 |
35 | The client is a language-specific library that you can use to connect your AI
36 | agent to the _Receiver Server_. The core concept of the client is to send an
37 | approval request to the server before your AI agent executes a certain function
38 | and waits for approval from the approvers.
39 |
40 | ### Dashboard
41 |
42 | Phantasm comes with a web-based dashboard that you can use to connect to the
43 | _Coordinator Server_ and monitor the incoming approval requests from your AI
44 | agents. You or your team can then approve, modify, or reject these requests.
45 |
--------------------------------------------------------------------------------
/dashboard/src/routes/+layout.svelte:
--------------------------------------------------------------------------------
1 |
39 |
40 | {#if hydrated}
41 |
14 |
17 |
26 | {connection.name}
15 |{connection.address}
16 |
42 | {
45 | showSidebar = false
46 | }}
47 | />
48 |
61 | {/if}
62 |
63 |
49 | {
51 | showSidebar = true
52 | }}
53 | />
54 |
55 |
56 |
57 |
59 |
60 |
64 | {#each $alerts as alert (alert.id)}
65 |
79 |
--------------------------------------------------------------------------------
/clients/python/phantasmpy/stubs/receiver_pb2.py:
--------------------------------------------------------------------------------
1 | # -*- coding: utf-8 -*-
2 | # Generated by the protocol buffer compiler. DO NOT EDIT!
3 | # NO CHECKED-IN PROTOBUF GENCODE
4 | # source: receiver.proto
5 | # Protobuf Python Version: 5.27.2
6 | """Generated protocol buffer code."""
7 | from google.protobuf import descriptor as _descriptor
8 | from google.protobuf import descriptor_pool as _descriptor_pool
9 | from google.protobuf import runtime_version as _runtime_version
10 | from google.protobuf import symbol_database as _symbol_database
11 | from google.protobuf.internal import builder as _builder
12 |
13 | _runtime_version.ValidateProtobufRuntimeVersion(
14 | _runtime_version.Domain.PUBLIC, 5, 27, 2, "", "receiver.proto"
15 | )
16 | # @@protoc_insertion_point(imports)
17 |
18 | _sym_db = _symbol_database.Default()
19 |
20 |
21 | from google.protobuf import empty_pb2 as google_dot_protobuf_dot_empty__pb2
22 |
23 |
24 | DESCRIPTOR = _descriptor_pool.Default().AddSerializedFile(
25 | b'\n\x0ereceiver.proto\x12\x08receiver\x1a\x1bgoogle/protobuf/empty.proto"$\n\x11HeartbeatResponse\x12\x0f\n\x07version\x18\x01 \x01(\t"G\n\x12GetApprovalRequest\x12\x0c\n\x04name\x18\x01 \x01(\t\x12\x12\n\nparameters\x18\x02 \x01(\t\x12\x0f\n\x07\x63ontext\x18\x03 \x01(\t";\n\x13GetApprovalResponse\x12\x10\n\x08\x61pproved\x18\x01 \x01(\x08\x12\x12\n\nparameters\x18\x02 \x01(\t2\x9c\x01\n\x08Receiver\x12\x42\n\tHeartbeat\x12\x16.google.protobuf.Empty\x1a\x1b.receiver.HeartbeatResponse"\x00\x12L\n\x0bGetApproval\x12\x1c.receiver.GetApprovalRequest\x1a\x1d.receiver.GetApprovalResponse"\x00\x62\x06proto3'
26 | )
27 |
28 | _globals = globals()
29 | _builder.BuildMessageAndEnumDescriptors(DESCRIPTOR, _globals)
30 | _builder.BuildTopDescriptorsAndMessages(DESCRIPTOR, "receiver_pb2", _globals)
31 | if not _descriptor._USE_C_DESCRIPTORS:
32 | DESCRIPTOR._loaded_options = None
33 | _globals["_HEARTBEATRESPONSE"]._serialized_start = 57
34 | _globals["_HEARTBEATRESPONSE"]._serialized_end = 93
35 | _globals["_GETAPPROVALREQUEST"]._serialized_start = 95
36 | _globals["_GETAPPROVALREQUEST"]._serialized_end = 166
37 | _globals["_GETAPPROVALRESPONSE"]._serialized_start = 168
38 | _globals["_GETAPPROVALRESPONSE"]._serialized_end = 227
39 | _globals["_RECEIVER"]._serialized_start = 230
40 | _globals["_RECEIVER"]._serialized_end = 386
41 | # @@protoc_insertion_point(module_scope)
42 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/navs/sidebar.svelte:
--------------------------------------------------------------------------------
1 |
29 |
30 | {#if open}
31 |
37 |
57 | {/if}
58 |
59 |
94 |
--------------------------------------------------------------------------------
/dashboard/src/lib/components/navs/header.svelte:
--------------------------------------------------------------------------------
1 |
29 |
30 |
70 | {
73 | removeAlert(alert.id)
74 | }}
75 | />
76 |
77 | {/each}
78 |
46 | saveProfile(approverName, approverEmail)}
69 | />
70 |
71 |
47 |
52 | Approver Profile
48 | 49 | This information adds more context to the approval response. 50 | 51 |
53 |
66 |
106 |
124 | {/if}
125 |
--------------------------------------------------------------------------------
/dashboard/src/routes/+page.svelte:
--------------------------------------------------------------------------------
1 |
55 |
56 |
107 |
123 | Approval Requests
108 | {#if requests.length == 0} 109 |There is no approval request to review at the moment.
110 | {:else} 111 |
112 | {#each requests as request (request.id)}
113 |
121 | {/if}
122 |
114 | removeRequest(request.id)}
117 | />
118 |
119 | {/each}
120 |
60 |
94 | Add Connection
61 |
62 |
75 |
76 | {
79 | if (connectionName && connectionAddress) {
80 | addConnection(connectionName, connectionAddress)
81 | showAddConnectionModal = false
82 | }
83 | }}
84 | />
85 | {
89 | showAddConnectionModal = false
90 | }}
91 | />
92 |
93 |
97 |
132 |
--------------------------------------------------------------------------------
/.github/CONTRIBUTING.md:
--------------------------------------------------------------------------------
1 | # Contributing Guidelines
2 |
3 | First off, thank you for considering to contribute to this project!
4 |
5 | Phantasm uses a wide-range of technologies and tools from different software
6 | development ecosystems. Therefore, we welcome contributions from all skill
7 | levels and backgrounds. We believe that a diverse community leads to a better
8 | product.
9 |
10 | ## Project Structure
11 |
12 | Phantasm consists of three main components: Server, Dashboard, and Client. The
13 | Dashboard and Client components are located in the _dashboard_ and _clients_
14 | directories, respectively, while the Server component is located in the _src_
15 | directory.
16 |
17 | Before you get started with contributing, you might need to set up your local
18 | development environment by installing the necessary dependencies. These are some
19 | of the primary technologies used to build Phantasm by its components:
20 |
21 | - **Server**: Rust, Tonic, gRPC, Tokio, Tungstenite
22 | - **Dashboard**: TypeScript, SvelteKit, Tailwind CSS
23 | - **Client**: Varies depending on the programming language
24 |
25 | ## Where to Start
26 |
27 | If you are new to the project, we recommend you to start by reading the
28 | project's documentation. The documentation provides an overview of the project,
29 | its components, and how they work together. If you have any questions, feel free
30 | to ask in the project's Discord server.
31 |
32 | After familiarizing yourself with the project structure, you can start to work
33 | on an issue that is listed in the Issues section of the project's repository.
34 | Some great issues to start with are the ones labeled as **good first issue**.
35 |
36 | ## Starting Development
37 |
38 | ### Server
39 |
40 | To start the server in development mode, you need to have Rust and Protobuf
41 | Compiler installed on your system. You can install them by following the
42 | instructions on their respective websites:
43 |
44 | - [Rust](https://www.rust-lang.org/tools/install)
45 | - [Protobuf Compiler](https://grpc.io/docs/protoc-installation)
46 |
47 | After installing the dependencies, you can run the following commands:
48 |
49 | ```bash
50 | # Test the server functionality.
51 | cargo test
52 |
53 | # Check the CLI options.
54 | cargo run -- --help
55 |
56 | # Start the server using the CLI.
57 | cargo run start
58 | ```
59 |
60 | ### Dashboard
61 |
62 | The dashboard is a web-based application built with SvelteKit. To start the
63 | dashboard in development mode, you need to have Node.js and NPM installed on
64 | your system. Assuming that you have them installed, you can run the following
65 | commands from the _dashboard_ directory:
66 |
67 | ```bash
68 | # Install the dependencies.
69 | npm install
70 |
71 | # Start the development server.
72 | npm run dev
73 | ```
74 |
75 | ### Documentation Website
76 |
77 | Phantasm's documentation website is built with MkDocs Material. To start the
78 | documentation website in development mode, you need to have Python and PIP
79 | installed on your local machine. Assuming that you have them installed already,
80 | you can run the following commands from the root directory:
81 |
82 | ```bash
83 | # Create a virtual environment.
84 | python -m venv .venv
85 |
86 | # Activate the virtual environment.
87 | source .venv/bin/activate
88 |
89 | # Install the dependencies.
90 | pip install -r requirements.txt
91 |
92 | # Start the development server.
93 | mkdocs serve
94 | ```
95 |
96 | ## Style Guides
97 |
98 | To maintain a consistent codebase, we follow a set of style guides for each
99 | component of the project. These style guides include settings from **rustfmt**
100 | for the Server, **Prettier** for the Dashboard, and the respective formatters
101 | for the Client Libraries, that you can find in their configuration files, such
102 | as **Black** for Python.
103 |
104 | ### Commit Messages & PRs
105 |
106 | To ensure that the project's commit history is clean and easy to read, we follow
107 | the Conventional Commits specification. When you are pushing changes to the
108 | project or creating a pull request, please make sure to follow this convention.
109 | In short, a commit message or a pull request title should look like this:
110 |
111 | ```
112 |
98 | {#if $connections.length == 0}
99 | {
127 | showAddConnectionModal = true
128 | }}
129 | />
130 |
131 |
100 |
106 | {:else}
107 | It looks quite empty in here!
101 |102 | Add your first connection to a Phantasm server to start receiving 103 | approval requests from your AI agents. 104 |
105 |
108 | {#each $connections as conn (conn.id)}
109 |
122 | {/if}
123 |
110 | {
113 | connect(conn.id)
114 | }}
115 | deleteConnection={() => {
116 | deleteConnection(conn.id)
117 | }}
118 | />
119 |
120 | {/each}
121 |
101 | {
139 | showTooltip = false
140 | }}
141 | />
142 |
143 |
144 |
102 | {#if request.context}
103 |
111 | {/if}
112 |
116 | 113 | {request.name} 114 |
115 |
117 |
121 |
124 |
132 |
133 |
134 |
135 |
145 |
146 | {#if error}
147 |
152 |
153 |
206 |
--------------------------------------------------------------------------------
/src/main.rs:
--------------------------------------------------------------------------------
1 | #![warn(unused_qualifications)]
2 |
3 | mod protos;
4 | mod services;
5 | mod types;
6 |
7 | use clap::{arg, ArgMatches, Command};
8 | use futures::{SinkExt, StreamExt};
9 | use protos::receiver_server::ReceiverServer;
10 | use services::{Configuration, Phantasm};
11 | use std::env;
12 | use std::net::{IpAddr, Ipv4Addr};
13 | use std::sync::Arc;
14 | use tokio::net::TcpListener;
15 | use tokio::sync::mpsc;
16 | use tokio_tungstenite::accept_async;
17 | use tonic::transport::Server;
18 | use tonic::{Request, Status};
19 | use types::{Connection, ConnectionID};
20 |
21 | const START_COMMAND: &str = "start";
22 |
23 | #[tokio::main]
24 | async fn main() {
25 | dotenv::dotenv().ok();
26 | tracing_subscriber::fmt::init();
27 |
28 | let cli = Command::new(env!("CARGO_PKG_NAME"))
29 | .version(env!("CARGO_PKG_VERSION"))
30 | .about("Interface to setup and manage Phantasm servers")
31 | .arg_required_else_help(true)
32 | .subcommand(start_command())
33 | .get_matches();
34 |
35 | match cli.subcommand() {
36 | Some((START_COMMAND, args)) => start_handler(args).await,
37 | _ => unreachable!(),
38 | }
39 | }
40 |
41 | fn start_command() -> Command {
42 | let arg_receiver_port =
43 | arg!(--"receiver-port"
148 | Syntax error occurred in the parameters
149 |
150 | {/if}
151 |