niuzhirui

Tutorials

Setting Up AutoByteus

Follow these steps to install and configure AutoByteus for your development environment.

1 Download AutoByteus Client

First, download the AutoByteus client for your operating system:

  1. Visit the homepage at https://www.niuzhirui.tech/

  2. Select the appropriate version for your operating system:

    πŸͺŸWindows: Click the Windows download button
    🍎macOS (Intel): For Macs with Intel processors
    🍎macOS (Apple Silicon): For Macs with M1/M2/M3 processors
    🐧Linux: For Linux-based operating systems
  3. Click the Download button to start the download
Download Section

2 Install Docker

AutoByteus requires Docker to run the LLM server container:

  1. Visit the Docker website at https://www.docker.com/
  2. Download Docker Desktop for your operating system
  3. Follow the installation instructions for your platform
  4. After installation, start Docker Desktop
  5. Verify Docker is running by checking for the Docker icon in your system tray/menu bar

3 Install AutoByteus Client

Windows Installation

  1. Locate the downloaded .exe installer file
  2. Right-click and select "Run as administrator"
  3. Follow the installation wizard instructions
  4. Choose your installation location when prompted
  5. Complete the installation and launch AutoByteus

macOS Installation

  1. Locate the downloaded .dmg file
  2. Double-click to open the disk image
  3. Drag the AutoByteus application to your Applications folder
  4. For first-time launch, right-click and select "Open" to bypass security warnings
  5. Enter your administrator password if prompted
  6. Before launching the app, open Terminal and run:
    xattr -d com.apple.quarantine /Applications/AutoByteus.app

Linux Installation

  1. Open a terminal in the download location
  2. Make the installer executable: chmod +x ./autobyteus-installer.AppImage
  3. Run the installer: ./autobyteus-installer.AppImage
  4. Follow the installation prompts
  5. Launch AutoByteus from your applications menu or terminal

4 Run the LLM Server Container

The LLM server runs in a Docker container and provides AI capabilities to AutoByteus:

  1. Open a terminal or command prompt
  2. Run the appropriate command for your operating system to start the LLM server:
    For macOS or Linux:
    docker rm -f llm-server 2>/dev/null || true && docker pull autobyteus/llm-server:latest && docker run -d --name llm-server --cap-add SYS_ADMIN --security-opt seccomp=unconfined -p 5900:5900 -p 6080:6080 -p 51739:51739 -e DISPLAY=:99 --restart unless-stopped autobyteus/llm-server:latest
    For Windows:
    powershell -Command "docker rm -f llm-server 2>$null; docker pull autobyteus/llm-server:latest; docker run -d --name llm-server --cap-add SYS_ADMIN --security-opt seccomp=unconfined -p 5900:5900 -p 6080:6080 -p 51739:51739 -e DISPLAY=:99 --restart unless-stopped autobyteus/llm-server:latest"
  3. Wait for the container to download and start (this may take a few minutes on first run)
  4. Verify the container is running with: docker ps
Note: These commands handle removing any existing container, pulling the latest image, and starting a new container with all required settings automatically.

5 Configure AutoByteus Client

Now that both AutoByteus and the LLM server are running, you need to verify the configuration:

First Launch

  1. Launch the AutoByteus client
  2. The first launch may take some time as it initializes. Please be patient.
  3. Once loaded, you will see the welcome screen

Server Settings

The server settings are automatically configured by the AutoByteus client. You can verify these settings if needed:

  1. Click the Settings icon in the sidebar (gear icon)
  2. Select "Server Settings" from the menu
  3. You will see two parameters that are automatically configured:
    • AUTOBYTEUS_LLM_SERVER_URL: Typically set to https://localhost:51739
    • AUTOBYTEUS_SERVER_HOST: Your local IP address (typically starts with 192.168.)
  4. These settings do not require manual configuration
Server Settings

Check Server Status

  1. In the Settings menu, click "Server Status"
  2. Verify that the server shows as "Running"
  3. The internal Python server should automatically start with AutoByteus
Server Status

6 Generate and Configure License Key

Your Niuzhirui account includes a trial subscription that provides a license key:

Generate License Key

  1. Log in to your Niuzhirui account at https://www.niuzhirui.tech/
  2. Navigate to your Profile page
  3. Click on "License Keys" in the sidebar
  4. Click "Generate New License Key"
  5. Copy the generated key immediately (it will only be shown once)
License Key Generation

Configure License Key in AutoByteus

  1. In AutoByteus, go to Settings
  2. Select "API Keys" from the menu
  3. Select "AUTOBYTEUS" from the provider dropdown
  4. Paste your license key in the field
  5. Click "Save API Key"
API Key Configuration
Note: You can also configure keys for other providers like DEEPSEEK, OpenAI, Claude, etc. if you have them

Trial Subscription

Your trial subscription is valid for 5 days. After that, you will need to purchase a subscription to continue using the service.

7 Set Up Your Workspace

A workspace is where you'll work on projects with AutoByteus:

Create a Workspace

  1. On the main screen, click "Create New Workspace"
  2. Enter a name for your workspace
  3. Enter the absolute path to your workspace folder (without trailing slash)
  4. Example: /home/username/projects/myproject or C:\Users\username\projects\myproject
  5. Click "Add Workspace"
Create Workspace

Workspace Interface

The workspace interface has several components:

  • Left panel: File explorer showing your workspace files
  • Middle panel: Chat interface for interacting with the LLM
  • Right panel: Terminal and VNC Viewer tabs
    • Terminal: For executing commands directly
    • VNC Viewer: Connected to the LLM server Docker container
Workspace Interface

8 Using the Workflow

AutoByteus provides a structured workflow for development:

Access the Workflow

  1. Click the left arrow button in the sidebar to open the workflow panel
  2. You'll see a list of workflow steps, each representing a different development stage
Workflow Panel

Workflow Steps

  • 1. Requirement: Define your project requirements
  • 2. Architecture Design: Plan your solution architecture
  • 3. Subtask Creation: Break down the project into manageable tasks
  • 4. UX Design: Design the user experience and interface
  • 5. Generate Tests: Create test cases for your project
  • 6. Implementation: Write the code to implement your solution
  • 7. Run Tests: Execute and verify your test cases
  • 8. Deployment: Package and deploy your solution

Current Usage

The Implementation step is currently the most developed. Other steps are still under active development.

πŸš€ You're all set! Enjoy using AutoByteus.