@blaxel/core 0.2.7-preview.6 → 0.2.7
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +116 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,116 @@
|
|
|
1
|
+
# Blaxel Typescript SDK
|
|
2
|
+
|
|
3
|
+
<p align="center">
|
|
4
|
+
<img src="https://blaxel.ai/logo.png" alt="Blaxel"/>
|
|
5
|
+
</p>
|
|
6
|
+
|
|
7
|
+
**Blaxel is a computing platform for AI agent builders, with all the services and infrastructure to build and deploy agents efficiently.** This repository contains the TypeScript SDK to create and manage resources on Blaxel.
|
|
8
|
+
|
|
9
|
+
## Table of Contents
|
|
10
|
+
|
|
11
|
+
- [Installation](#installation)
|
|
12
|
+
- [Optional libraries](#optional-libraries)
|
|
13
|
+
- [Authentication](#authentication)
|
|
14
|
+
- [Features](#features)
|
|
15
|
+
- [Quickstart](#quickstart)
|
|
16
|
+
- [Contributing](#contributing)
|
|
17
|
+
- [License](#license)
|
|
18
|
+
|
|
19
|
+
|
|
20
|
+
|
|
21
|
+
## Installation
|
|
22
|
+
|
|
23
|
+
Install Blaxel core SDK, which lets you manage Blaxel resources.
|
|
24
|
+
|
|
25
|
+
```bash
|
|
26
|
+
## npm
|
|
27
|
+
npm install @blaxel/core
|
|
28
|
+
|
|
29
|
+
## pnpm
|
|
30
|
+
pnpm i @blaxel/core
|
|
31
|
+
|
|
32
|
+
## yarn
|
|
33
|
+
yarn add @blaxel/core
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
|
|
37
|
+
### Optional libraries
|
|
38
|
+
Blaxel SDK is split between multiple packages. *core* is the minimal package to connect to Blaxel. You can find other packages to help you integrate with your favorite AI framework, or set up telemetry.
|
|
39
|
+
|
|
40
|
+
- [@blaxel/telemetry](@blaxel/telemetry/README.md)
|
|
41
|
+
- [@blaxel/vercel](@blaxel/vercel/README.md)
|
|
42
|
+
- [@blaxel/llamaindex](@blaxel/llamaindex/README.md)
|
|
43
|
+
- [@blaxel/langgraph](@blaxel/langgraph/README.md)
|
|
44
|
+
- [@blaxel/mastra](@blaxel/mastra/README.md)
|
|
45
|
+
|
|
46
|
+
Instrumentation happens automatically when workloads run on Blaxel. To enable telemetry, simply require the SDK in your project's entry point.
|
|
47
|
+
```ts
|
|
48
|
+
import "@blaxel/telemetry";
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
|
|
52
|
+
### Authentication
|
|
53
|
+
|
|
54
|
+
The Blaxel SDK authenticates with your workspace using credentials from these sources, in priority order:
|
|
55
|
+
1. When running on Blaxel, authentication is handled automatically
|
|
56
|
+
2. Variables in your .env file (`BL_WORKSPACE` and `BL_API_KEY`, or see [this page](https://docs.blaxel.ai/Agents/Variables-and-secrets) for other authentication options).
|
|
57
|
+
3. Environment variables from your machine
|
|
58
|
+
4. Configuration file created locally when you log in through Blaxel CLI (or deploy on Blaxel)
|
|
59
|
+
|
|
60
|
+
When developing locally, the recommended method is to just log in to your workspace with Blaxel CLI. This allows you to run Blaxel SDK functions that will automatically connect to your workspace without additional setup. When you deploy on Blaxel, this connection persists automatically.
|
|
61
|
+
|
|
62
|
+
When running Blaxel SDK from a remote server that is not Blaxel-hosted, we recommend using environment variables as described in the third option above.
|
|
63
|
+
|
|
64
|
+
|
|
65
|
+
|
|
66
|
+
## Features
|
|
67
|
+
- Agents & MCP servers
|
|
68
|
+
- [Create MCP servers](https://docs.blaxel.ai/Functions/Create-MCP-server)
|
|
69
|
+
- [Connect to MCP servers and model APIs hosted on Blaxel](https://docs.blaxel.ai/Agents/Develop-an-agent-ts)
|
|
70
|
+
- [Call agents from another agent](https://docs.blaxel.ai/Agents/Develop-an-agent-ts#connect-to-another-agent-multi-agent-chaining)
|
|
71
|
+
- [Deploy on Blaxel](https://docs.blaxel.ai/Agents/Deploy-an-agent)
|
|
72
|
+
- Sandboxes
|
|
73
|
+
- [Create and update sandboxes and sandbox previews](https://docs.blaxel.ai/Sandboxes/Overview)
|
|
74
|
+
- [Run filesystem operations and processes on a sandbox](https://docs.blaxel.ai/Sandboxes/Processes)
|
|
75
|
+
- [Use environment variables or secrets](https://docs.blaxel.ai/Agents/Variables-and-secrets)
|
|
76
|
+
|
|
77
|
+
|
|
78
|
+
|
|
79
|
+
## Quickstart
|
|
80
|
+
|
|
81
|
+
Blaxel CLI gives you a quick way to create new applications: agents, MCP servers, jobs, etc - and deploy them to Blaxel.
|
|
82
|
+
|
|
83
|
+
**Prerequisites**:
|
|
84
|
+
- **Node.js:** v18 or later.
|
|
85
|
+
- **Blaxel CLI:** Make sure you have Blaxel CLI installed. If not, [install it](https://docs.blaxel.ai/cli-reference/introduction):
|
|
86
|
+
```bash
|
|
87
|
+
curl -fsSL \
|
|
88
|
+
https://raw.githubusercontent.com/blaxel-ai/toolkit/main/install.sh \
|
|
89
|
+
| BINDIR=/usr/local/bin sudo -E sh
|
|
90
|
+
```
|
|
91
|
+
- **Blaxel login:** Login to Blaxel:
|
|
92
|
+
```bash
|
|
93
|
+
bl login YOUR-WORKSPACE
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
```bash
|
|
97
|
+
bl create-agent-app myfolder
|
|
98
|
+
cd myfolder
|
|
99
|
+
bl deploy
|
|
100
|
+
```
|
|
101
|
+
|
|
102
|
+
Also available:
|
|
103
|
+
- `bl create-mcp-server`
|
|
104
|
+
- `bl create-job`
|
|
105
|
+
|
|
106
|
+
|
|
107
|
+
|
|
108
|
+
## Contributing
|
|
109
|
+
|
|
110
|
+
Contributions are welcome! Please feel free to submit a Pull Request.
|
|
111
|
+
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
## License
|
|
115
|
+
|
|
116
|
+
This project is licensed under the MIT License - see the LICENSE file for details.
|