1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
---
title: Web
description: Using OpenCode in your browser.
---
OpenCode can run as a web application in your browser, providing the same powerful AI coding experience without needing a terminal.
## Getting Started
Start the web interface by running:
```bash
opencode web
```
This starts a local server on `127.0.0.1` with a random available port and automatically opens OpenCode in your default browser.
:::caution
If `OPENCODE_SERVER_PASSWORD` is not set, the server will be unsecured. This is fine for local use but should be set for network access.
:::
:::tip[Windows Users]
For the best experience, run `opencode web` from [WSL](/docs/windows-wsl) rather than PowerShell. This ensures proper file system access and terminal integration.
:::
---
## Configuration
You can configure the web server using command line flags or in your [config file](/docs/config).
### Port
By default, OpenCode picks an available port. You can specify a port:
```bash
opencode web --port 4096
```
### Hostname
By default, the server binds to `127.0.0.1` (localhost only). To make OpenCode accessible on your network:
```bash
opencode web --hostname 0.0.0.0
```
When using `0.0.0.0`, OpenCode will display both local and network addresses:
```
Local access: http://localhost:4096
Network access: http://192.168.1.100:4096
```
### mDNS Discovery
Enable mDNS to make your server discoverable on the local network:
```bash
opencode web --mdns
```
This automatically sets the hostname to `0.0.0.0` and advertises the server as `opencode.local`.
You can customize the mDNS domain name to run multiple instances on the same network:
```bash
opencode web --mdns --mdns-domain myproject.local
```
### CORS
To allow additional domains for CORS (useful for custom frontends):
```bash
opencode web --cors https://example.com
```
### Authentication
To protect access, set a password using the `OPENCODE_SERVER_PASSWORD` environment variable:
```bash
OPENCODE_SERVER_PASSWORD=secret opencode web
```
The username defaults to `opencode` but can be changed with `OPENCODE_SERVER_USERNAME`.
---
## Using the Web Interface
Once started, the web interface provides access to your OpenCode sessions.
### Sessions
View and manage your sessions from the homepage. You can see active sessions and start new ones.
### Server Status
Click "See Servers" to view connected servers and their status.
---
## Attaching a Terminal
You can attach a terminal TUI to a running web server:
```bash
# Start the web server
opencode web --port 4096
# In another terminal, attach the TUI
opencode attach http://localhost:4096
```
This allows you to use both the web interface and terminal simultaneously, sharing the same sessions and state.
---
## Config File
You can also configure server settings in your `opencode.json` config file:
```json
{
"server": {
"port": 4096,
"hostname": "0.0.0.0",
"mdns": true,
"cors": ["https://example.com"]
}
}
```
Command line flags take precedence over config file settings.
|
