Getting Started with Portal
Why I Created This Project
OpenCode is an open-source coding agent that provides a terminal-based user interface, desktop application, and web interface. While highly flexible, the current web interface lacks polish and mobile responsiveness.
Portal addresses these limitations by offering a mobile-first UI that connects to the OpenCode server. It enables you to make changes to your codebase using OpenCode as the underlying harness, providing a clean and responsive experience across all devices.
How You Can Use This Project
Local Network Access
If you’re working within your home network (a private network not accessible from the internet), you can easily set up Portal by running OpenCode in your project root directory and launching the Portal application. Simply connect to Portal from your mobile device using your local network IP address.
Remote Access
For accessing your codebase when you’re outside your home network, follow these steps:
- Set up a VPS (Virtual Private Server) server
- Host your codebase on this server
- Install Portal and OpenCode on the server
- Use Tailscale to create a secure network connection between your mobile device and the server
- Access the Portal web interface through the secure connection
This approach allows you to securely work on your codebase from anywhere using your mobile device while maintaining the security of a private network.
Getting Started
This guide will walk you through installing the necessary components for your environment.
Installation
1. Install OpenCode
First, install the OpenCode CLI agent:
curl -fsSL https://opencode.ai/install | bash2. Install Docker
If you haven’t already, install Docker for your operating system.
3. Remote Access (Optional)
If you are deploying this architecture on a remote server, we recommend installing Tailscale for secure remote access.