fluxflow-cli 1.0.12 โ 1.1.0
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 +80 -71
- package/UI_FEATURES.md +1 -0
- package/dist/fluxflow.js +469 -268
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -1,71 +1,80 @@
|
|
|
1
|
-
#
|
|
2
|
-
|
|
3
|
+
|
|
4
|
+
**A Beautiful, Autonomous Terminal AI Agent**
|
|
5
|
+
|
|
6
|
+
Flux Flow is an advanced, fully autonomous AI agent that lives directly in your terminal. Built with Node.js and [Ink](https://github.com/vadimdemedes/ink) (React for interactive command-line apps), it provides a highly responsive, component-based UI powered by a sophisticated dual-model AI architecture.
|
|
7
|
+
|
|
8
|
+
Whether you need a conversational partner or an autonomous developer that can write code, run shell commands, and read your project files, Flux Flow adapts to your needs.
|
|
9
|
+
|
|
10
|
+
---
|
|
11
|
+
|
|
12
|
+
## โจ Features
|
|
13
|
+
|
|
14
|
+
- **Responsive Terminal UI**: A gorgeous, reactive interface built with React and Ink, featuring multi-line input, status bars, modals, and diff views.
|
|
15
|
+
- **Dual-Model Architecture**: A primary agent interacts with you and executes tasks, while a silent background "Janitor" model handles chat summarization and long-term memory extraction without blocking the main UI.
|
|
16
|
+
- **Two Operating Modes**:
|
|
17
|
+
- **Flux (Dev Mode)**: Full system access. The agent can read/write files, execute shell commands, and run autonomous agentic loops (up to 45 iterations) to solve complex coding tasks.
|
|
18
|
+
- **Flow (Chat Mode)**: Focused on conversation and web research, with limited agentic loops for faster response times.
|
|
19
|
+
- **Advanced Memory System**: Features both temporary session context and persistent, cross-session user memories encrypted locally on your machine.
|
|
20
|
+
- **Agentic Tooling**: Built-in tools for smart file patching, web scraping, web searching, and terminal execution.
|
|
21
|
+
- **Autonomous Project Alignment**: Automatically detects and adheres to project-specific instructions in `Agent.md`, `Skills.md`, and `Fluxflow.md` for high-fidelity coding standards and complex workflows.
|
|
22
|
+
- **Customizable "Thinking" Levels**: Adjust the depth of the model's reasoning process (from Minimal to Max).
|
|
23
|
+
- **High-Reliability Fallback**: Automatic failover to a lighter, high-concurrency model (Gemini 3.1 Flash Lite) during peak traffic to ensure 100% session persistence.
|
|
24
|
+
|
|
25
|
+
## ๐ Quick Start
|
|
26
|
+
|
|
27
|
+
### Prerequisites
|
|
28
|
+
- [Node.js](https://nodejs.org/) (v18 or higher recommended)
|
|
29
|
+
- `npm`, `yarn`, or `pnpm`
|
|
30
|
+
|
|
31
|
+
### Via NPM (Global & Instant)
|
|
32
|
+
You can run the agent instantly or install it globally for high-speed access:
|
|
33
|
+
|
|
34
|
+
```bash
|
|
35
|
+
# Run instantly (Zero Setup)
|
|
36
|
+
npx fluxflow-cli
|
|
37
|
+
|
|
38
|
+
# OR Install Globally
|
|
39
|
+
npm install -g fluxflow-cli
|
|
40
|
+
fluxflow
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
### From Source (Local Development)
|
|
44
|
+
1. Clone the repository and install dependencies:
|
|
45
|
+
```bash
|
|
46
|
+
git clone <repository-url>
|
|
47
|
+
cd Flux-Flow
|
|
48
|
+
npm install
|
|
49
|
+
```
|
|
50
|
+
|
|
51
|
+
2. Start the agent:
|
|
52
|
+
```bash
|
|
53
|
+
npm start
|
|
54
|
+
```
|
|
55
|
+
|
|
56
|
+
## ๐ Documentation
|
|
57
|
+
|
|
58
|
+
To keep this README concise, detailed information about specific components of Flux Flow has been split into separate documents:
|
|
59
|
+
|
|
60
|
+
- **[Architecture & Design](./ARCHITECTURE.md)**: Deep dive into the React/Ink rendering, the Agentic Loop, and the Janitor background process.
|
|
61
|
+
- **[Agent Tools & Capabilities](./TOOLS.md)**: A comprehensive list of the tools available to the agent (e.g., File I/O, Execution, Web tools).
|
|
62
|
+
- **[UI & Interaction Features](./UI_FEATURES.md)**: Details on commands, thinking levels, and human-in-the-loop verification.
|
|
63
|
+
|
|
64
|
+
## ๐ Security & Privacy
|
|
65
|
+
|
|
66
|
+
Flux Flow runs entirely locally on your machine.
|
|
67
|
+
- **Global Storage**: All history, memories, and API keys are stored securely in your home directory at `~/.fluxflow`. Sensitive data is encrypted.
|
|
68
|
+
- **Nuclear Reset**: Use the `/reset` command to instantly purge all logs, secrets, and settings from the global storage directory.
|
|
69
|
+
- **Configurable Boundaries**: In Flux mode, file access can be strictly confined to the Current Working Directory, or expanded globally via settings.
|
|
70
|
+
- **API Keys**: You supply your own Gemini/Google AI Studio API keys.
|
|
71
|
+
|
|
72
|
+
## ๐ ๏ธ Built With
|
|
73
|
+
|
|
74
|
+
- **[React](https://react.dev/) & [Ink](https://github.com/vadimdemedes/ink)**: For the interactive CLI rendering.
|
|
75
|
+
- **[@google/genai](https://www.npmjs.com/package/@google/genai)**: The core AI SDK powering the agent's intelligence.
|
|
76
|
+
- **[chalk](https://www.npmjs.com/package/chalk) & [gradient-string](https://www.npmjs.com/package/gradient-string)**: For terminal styling and aesthetics.
|
|
77
|
+
- **[fs-extra](https://www.npmjs.com/package/fs-extra)**: For robust file system operations.
|
|
78
|
+
|
|
79
|
+
---
|
|
80
|
+
*Created as a demonstration of highly capable AI tooling.*
|
package/UI_FEATURES.md
CHANGED
|
@@ -14,6 +14,7 @@ You can control the application using `/` commands directly in the chat input:
|
|
|
14
14
|
- **/profile**: Update your name, nickname, and custom instructions.
|
|
15
15
|
- **/memory**: View and manage the persistent memories extracted by the Janitor.
|
|
16
16
|
- **/resume <chat-id>**: Switch back to a previous conversation.
|
|
17
|
+
- **/changelog**: Open the project's changelog in your default browser.
|
|
17
18
|
- **/help**: List all available commands.
|
|
18
19
|
|
|
19
20
|
### Command Shortcuts
|