nuwax
starsforks
How to install nuwax?
nuwax-ai/nuwax
$git clone https://github.com/nuwax-ai/nuwaxNuwax AI - Easily build and deploy your private Agentic AI solutions.
README.md
| 1 | # Nuwax |
| 2 | |
| 3 | Nuwax AI - Easily build and deploy your private Agentic AI solutions. |
| 4 | |
| 5 | Official Website: [https://nuwax.com](https://nuwax.com) |
| 6 | |
| 7 | Demo: [https://agent.nuwax.com](https://agent.nuwax.com) |
| 8 | |
| 9 | [中文文档](README.zh-CN.md)|[English Doc](README.md) | [Contributing](CONTRIBUTING.md) | [Documentation](docs/) |
| 10 | |
| 11 | ## Installation & Deployment |
| 12 | |
| 13 | Use the official nuwax-cli command tool to quickly deploy services locally. |
| 14 | |
| 15 | ### Quick Start |
| 16 | |
| 17 | #### Environment Preparation |
| 18 | |
| 19 | ##### System Requirements |
| 20 | |
| 21 | - **System Requirements**: Ubuntu 22.04 LTS or later (other Linux versions not fully tested), macOS 10.15+, Windows 10/11 (support coming soon) |
| 22 | - **Hardware Requirements**: 4 cores 8GB RAM or higher |
| 23 | - **Environment Requirements**: docker, docker-compose V2 environment [Docker Installation Guide](#docker-environment-installation) |
| 24 | |
| 25 | ##### Supported Platforms |
| 26 | |
| 27 | - **Linux**: x86_64, ARM64 |
| 28 | - Ubuntu 22.04 LTS (recommended) |
| 29 | - Current user needs Docker permissions, verify with `docker ps`. If you encounter permission issues, you can run with sudo privileges. |
| 30 | - Alibaba Cloud mirror acceleration is recommended |
| 31 | - **macOS**: Intel, Apple Silicon (M1/M2), Universal |
| 32 | - macOS 10.15 (Catalina) and later versions |
| 33 | - OrbStack is recommended (free for personal use, better performance) |
| 34 | - Ensure OrbStack or Docker Desktop is started |
| 35 | - First-time use may require allowing unknown developers: System Preferences → Security & Privacy |
| 36 | |
| 37 | #### Local Deployment Service Guide |
| 38 | |
| 39 | There are 2 deployment services: |
| 40 | |
| 41 | - Main project service (required) |
| 42 | - Agent Computer (Sandbox) deployment guide (optional) |
| 43 | |
| 44 | In the main local service, configure one or more Agent Computer deployment addresses to use the Agent Computer (Sandbox). Since the "Agent Computer (Sandbox)" includes a personal computer (sandbox) which requires more resources, it supports separate deployment across multiple servers. |
| 45 | |
| 46 | #### Deploy Main Service |
| 47 | |
| 48 | [Installation Documentation](https://nuwax.com/deploy.html) |
| 49 | |
| 50 | #### Agent Computer (Sandbox) Deployment Guide |
| 51 | |
| 52 | You can deploy Agent Computer services on multiple different servers, achieving distributed agent sandbox capabilities through configuration. |
| 53 | |
| 54 | > **Environment Requirements**: Each server needs Docker and Docker Compose environment installed, refer to [Docker Installation Documentation](https://nuwax.com/deploy.html#%E6%8E%A8%E8%8D%90%E6%96%B9%E6%A1%88-%E4%B8%80%E9%94%AE%E5%AE%89%E8%A3%85%E9%85%8D%E7%BD%AE-docker-%E8%84%9A%E6%9C%AC). |
| 55 | |
| 56 | [Installation Documentation](https://nuwax.com/agent-computer-deploy.html) |
| 57 | |
| 58 | ### Common Management Commands |
| 59 | |
| 60 | #### Service Management |
| 61 | |
| 62 | - Start service: `./nuwax-cli docker-service start` |
| 63 | - Stop service: `./nuwax-cli docker-service stop` |
| 64 | - Restart service: `./nuwax-cli docker-service restart` |
| 65 | - Check status: `./nuwax-cli docker-service status` |
| 66 | |
| 67 | #### Backup Management |
| 68 | |
| 69 | > Backup service requires stopping Docker application servers, it's recommended to operate during business low-peak periods |
| 70 | |
| 71 | - **One-click Backup (Recommended):** |
| 72 | - Manual backup execution: `./nuwax-cli auto-backup run` |
| 73 | - List all backups: `./nuwax-cli list-backups` |
| 74 | - Restore from backup: `./nuwax-cli rollback [BACKUP_ID]` |
| 75 | |
| 76 | #### Upgrade Management |
| 77 | |
| 78 | **Application service upgrade, using command `./nuwax-cli auto-upgrade-deploy run` will automatically detect and download new versions for deployment.** |
| 79 | |
| 80 | Complete upgrade process: |
| 81 | |
| 82 | ```bash |
| 83 | # Check if deployment client has new version and update |
| 84 | ./nuwax-cli check-update install |
| 85 | # Update application service |
| 86 | ./nuwax-cli auto-upgrade-deploy run |
| 87 | ``` |
| 88 | |
| 89 | ### Docker Environment Installation |
| 90 | |
| 91 | > **Important Note**: Docker and Docker Compose are core dependencies for running this service and must be installed correctly. |
| 92 | |
| 93 | If your system doesn't have Docker environment installed yet, please refer to the detailed **[Docker Environment Installation Guide](docs/en/docker-install.md)**. |
| 94 | |
| 95 | This installation guide includes detailed installation steps for the following platforms: |
| 96 | |
| 97 | - **Ubuntu 24.04.3 LTS** (recommended Linux distribution) |
| 98 | - **macO |
People who liked this also viewed
6 picksType
- odoo-mcp-proAI connector for Odoo ERP | Connect Claude, ChatGPT, Cursor and other AI tools to Odoo via MCPMCP ServersJul 2026
- omnigentUniversal autonomous agent framework with ReAct loop, multi-provider LLM routing, reasoning graph, and MCP integration, domain-agnostic for building specialized AI agents.MCP ServersFeb 2026
- arxiv-mcp-serverAn MCP server that enables interacting with the arXiv API using natural languageMCP ServersAug 2025
- United States WeatherProvide real-time and forecast weather information for locations in the United States using natural language queries. Access current conditions, multi-day and hourly forecasts, weather alerts, and nearby weather stations without requiring aMCP Serversrecently
- mcp-server-demoDemo of MCP Server in Python using FastMCPMCP ServersAug 2025
- mcp-serverlearn to make some mcp serversMCP ServersMay 2025
