@photon-ai/flux 0.3.3 → 0.3.5
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 +15 -13
- package/dist/index.js +2698 -8779
- package/dist/index.js.map +1 -1
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -16,7 +16,7 @@
|
|
|
16
16
|
|
|
17
17
|
Flux is an open-sourced CLI tool that lets developers build and deploy LangChain agents that connect to iMessage at no cost and under 5 seconds.
|
|
18
18
|
|
|
19
|
-
---
|
|
19
|
+
<!-- --- -->
|
|
20
20
|
|
|
21
21
|
## Features
|
|
22
22
|
|
|
@@ -26,16 +26,18 @@ Flux is an open-sourced CLI tool that lets developers build and deploy LangChain
|
|
|
26
26
|
- **Phone Number Authentication**: Log in with just your phone number and iMessage.
|
|
27
27
|
- **Agent Validation**: Automatically validate your LangChain agent in the CLI.
|
|
28
28
|
|
|
29
|
-
---
|
|
29
|
+
<!-- --- -->
|
|
30
30
|
|
|
31
31
|
## Installation
|
|
32
32
|
|
|
33
|
+
###
|
|
33
34
|
```
|
|
34
35
|
npm install @photon-ai/flux
|
|
36
|
+
#or
|
|
35
37
|
bun add @photon-ai/flux
|
|
36
38
|
```
|
|
37
39
|
|
|
38
|
-
---
|
|
40
|
+
<!-- --- -->
|
|
39
41
|
|
|
40
42
|
## CLI Commands
|
|
41
43
|
|
|
@@ -49,13 +51,13 @@ bun add @photon-ai/flux
|
|
|
49
51
|
| `npx @photon-ai/flux run --prod` | Start with live iMessage bridge |
|
|
50
52
|
| `npx @photon-ai/flux validate` | Check your code for errors |
|
|
51
53
|
|
|
52
|
-
---
|
|
54
|
+
<!-- --- -->
|
|
53
55
|
|
|
54
56
|
## Flux Number
|
|
55
57
|
|
|
56
|
-
Message
|
|
58
|
+
Message `+16286298650` with you phone number to text the LangChain agent that you built.
|
|
57
59
|
|
|
58
|
-
---
|
|
60
|
+
<!-- --- -->
|
|
59
61
|
|
|
60
62
|
## Log in
|
|
61
63
|
|
|
@@ -64,13 +66,13 @@ Authentication is based on iMessage:
|
|
|
64
66
|
- The server generates a UUID per login attempt. It then waits for the iMessage text from the client with the UUID. Once verified, it will issue a token.
|
|
65
67
|
- Credentials (token, phone, timestamp) are saved to credentials.json. This way, the user only has to log in once.
|
|
66
68
|
|
|
67
|
-
---
|
|
69
|
+
<!-- --- -->
|
|
68
70
|
|
|
69
71
|
## Usage
|
|
70
72
|
|
|
71
|
-
|
|
73
|
+
### Step 1: Create LangChain Agent
|
|
72
74
|
|
|
73
|
-
Create agent.ts file with your LangChain agent:
|
|
75
|
+
Create an `agent.ts` file with your LangChain agent. Make sure to have `export default agent`. Below is one simple example:
|
|
74
76
|
|
|
75
77
|
```
|
|
76
78
|
// agent.ts
|
|
@@ -155,7 +157,7 @@ npx @photon-ai/flux run --prod
|
|
|
155
157
|
|
|
156
158
|
```
|
|
157
159
|
|
|
158
|
-
---
|
|
160
|
+
<!-- --- -->
|
|
159
161
|
|
|
160
162
|
## Why Flux
|
|
161
163
|
|
|
@@ -169,7 +171,7 @@ Flux solves these problems in the following ways:
|
|
|
169
171
|
- **Open source**: Fully community driven.
|
|
170
172
|
- **Free to use**: No subscription fees.
|
|
171
173
|
|
|
172
|
-
---
|
|
174
|
+
<!-- --- -->
|
|
173
175
|
|
|
174
176
|
## Examples
|
|
175
177
|
|
|
@@ -244,7 +246,7 @@ export default {
|
|
|
244
246
|
};
|
|
245
247
|
```
|
|
246
248
|
|
|
247
|
-
---
|
|
249
|
+
<!-- --- -->
|
|
248
250
|
|
|
249
251
|
## Requirements
|
|
250
252
|
|
|
@@ -252,7 +254,7 @@ export default {
|
|
|
252
254
|
- **Python** 3.9+ (for the agent)
|
|
253
255
|
- **LLM Keys (e.g. OpenAI API key)**
|
|
254
256
|
|
|
255
|
-
---
|
|
257
|
+
<!-- --- -->
|
|
256
258
|
|
|
257
259
|
|
|
258
260
|
<div align="center">
|