Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 30 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@

# Fuel Agent Kit

## Overview
Fuel Agent Kit is an agentic framework designed to enhance the capabilities of the Fuel Network. It provides tools, libraries, and infrastructure to build, deploy, and manage intelligent agents that can interact with the Fuel Network ecosystem.

## Prerequisites
Before you begin, ensure you have the following installed on your system:

- **Fuel Toolchain**: The Fuel development environment and toolchain.
- **Node.js**: Version 16 or higher for building and running agent applications.

## Installation

1. **Clone the Repository**:
```bash
git clone https://github.com/priyanshudumps/fuel-agent-kit.git
cd fuel-agent-kit
```

2. **Install Dependencies**:
```bash
npm install
```

3. **Set Up Environment**:
Configure your environment variables as specified in the `.env.example` file.

## License
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
97 changes: 97 additions & 0 deletions docs/fuel-node-setup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,97 @@

# Running a Fuel Node Guide

This guide provides a step-by-step walkthrough for developers to run a local Fuel node using either Docker or the Fuel toolchain (`fuel-core`).

---

## Prerequisites

Before starting, ensure you have the following installed:

- **Docker** (for Docker-based setup)
- **Rust** (for Fuel toolchain setup)
- **Git** (for cloning repositories)

---

## Option 1: Running a Fuel Node with Docker

### Step 1: Pull the Fuel Docker Image

```bash
docker pull fuel-labs/fuel-node:latest
```

### Step 2: Run a Fuel Node Container

```bash
docker run -d \
--name fuel-node \
-p 4000:4000 \
-p 4001:4001 \
-v fuel-node-data:/data \
fuel-labs/fuel-node:latest
```

### Step 3: Verify the Node is Running

Check the logs to ensure the node is running correctly:

```bash
docker logs fuel-node
```

### Step 4: Interact with the Node

You can interact with the node using the `fuel-core` CLI:

```bash
docker exec -it fuel-node fuel-core
```

---

## Option 2: Running a Fuel Node with Fuel Toolchain

### Step 1: Install Rust and Cargo

Ensure you have Rust and Cargo installed. If not, follow the [official Rust installation guide](https://www.rust-lang.org/tools/install).

### Step 2: Clone the Fuel Repository

```bash
git clone https://github.com/FuelLabs/fuel-core.git
cd fuel-core
```

### Step 3: Build and Run the Fuel Node

```bash
cargo build --release
./target/release/fuel-core --dev
```

### Step 4: Verify the Node is Running

Check the logs to ensure the node is running:

```bash
tail -f logs/dev.log
```

---

## Connecting to the Node

Once your node is running, you can connect to it using the following endpoints:

- **RPC Endpoint:** `http://localhost:4000`
- **WebSocket Endpoint:** `ws://localhost:4001`

---

## Next Steps

- Explore the [Fuel Documentation](https://docs.fuel.sh) for more advanced usage.
- Join the [Fuel Community](https://discord.gg/fuel) for support and discussions.
49 changes: 49 additions & 0 deletions python/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@

# Fuel Agent Kit - Python Implementation

Fuel Agent Kit provides tools for building and managing fuel agents in Python.

## Prerequisites

- Python 3.10 or higher
- pip package manager

## Installation

Install the Fuel Agent Kit using pip:

```bash
pip install fuel-agent-kit
```

## Quick Start

Here's how to initialize a basic Fuel Agent:

```python
from fuel_agent import FuelAgent

# Initialize a new Fuel Agent
agent = FuelAgent(
agent_id="my_agent_123",
name="My Fuel Agent",
description="A sample fuel agent implementation"
)

# Start the agent
agent.start()

# Stop the agent when done
agent.stop()
```

## Features

- Fuel agent management
- Configuration and initialization
- Integration with fuel infrastructure
- Extensible architecture for custom agents

## Documentation

For more detailed documentation and API reference, please visit our [official documentation](https://fuel-agent-kit.org/docs).