Skip to content

Commit 531f51b

Browse files
committed
Update landing pages to use 'ogx go' instead of 'ogx run starter'
Signed-off-by: Matthew Farrellee <matt@cs.wisc.edu>
1 parent f227ef4 commit 531f51b

4 files changed

Lines changed: 23 additions & 22 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -60,10 +60,10 @@ Install and run a OGX server:
6060
curl -LsSf https://github.com/ogx-ai/ogx/raw/main/scripts/install.sh | bash
6161

6262
# Or install via uv
63-
uv pip install ogx[starter]
63+
uv pip install ogx
6464

65-
# Start the server (uses the starter distribution with Ollama)
66-
uv run ogx run starter
65+
# Start the server (auto-detects providers from the environment)
66+
uv run ogx go
6767
```
6868

6969
Then connect with any OpenAI, Anthropic, or Google GenAI client — [Python](https://github.com/openai/openai-python), [TypeScript](https://github.com/openai/openai-node), [curl](https://platform.openai.com/docs/api-reference), or any framework that speaks these APIs.

docs/docs/getting_started/quickstart.mdx

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,15 @@ Install [Ollama](https://ollama.com/download), then pull a model and start the s
1919

2020
```bash
2121
ollama pull llama3.2:3b
22-
export OLLAMA_URL=http://localhost:11434/v1
23-
uvx --from 'ogx[starter]' ogx run starter
22+
uvx ogx go
2423
```
2524

2625
</TabItem>
2726
<TabItem value="openai" label="OpenAI">
2827

2928
```bash
3029
export OPENAI_API_KEY=sk-xxx
31-
uvx --from 'ogx[starter]' ogx run starter
30+
uvx ogx go
3231
```
3332

3433
</TabItem>
@@ -52,13 +51,14 @@ The `uvx` command above is great for trying things out. For a real project, inst
5251

5352
```bash
5453
uv init my-ai-app && cd my-ai-app
55-
uv add 'ogx[starter]' openai
56-
export OLLAMA_URL=http://localhost:11434/v1
57-
uv run ogx run starter
54+
uv add ogx openai
55+
uv run ogx go
5856
```
5957
:::
6058

61-
The server is now running at `http://localhost:8321`. You can use any OpenAI-compatible client.
59+
The server is now running at `https://localhost:8321`. You can use any OpenAI-compatible client.
60+
61+
OGX is secure by default and listens on https. Passing `--insecure` forces the server to listen on http.
6262

6363
## Verify it works
6464

@@ -68,16 +68,17 @@ Before writing any code, confirm the server is healthy and models are registered
6868
<TabItem value="curl" label="curl" default>
6969

7070
```bash
71-
curl -s http://localhost:8321/v1/models | python -m json.tool
71+
curl -k -s https://localhost:8321/v1/models | python -m json.tool
7272
```
7373

7474
</TabItem>
7575
<TabItem value="python" label="Python">
7676

7777
```python
78+
import httpx
7879
from openai import OpenAI
7980

80-
client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake")
81+
client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake", http_client=httpx.Client(verify=False))
8182

8283
for model in client.models.list():
8384
print(model.id)
@@ -108,9 +109,10 @@ If the list is empty or the command fails, check the [Troubleshooting](#troubles
108109
Open a new terminal and run:
109110

110111
```python title="app.py"
112+
import httpx
111113
from openai import OpenAI
112114

113-
client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake")
115+
client = OpenAI(base_url="https://localhost:8321/v1", api_key="fake", http_client=httpx.Client(verify=False))
114116

115117
response = client.responses.create(
116118
model="ollama/llama3.2:3b",
@@ -128,9 +130,10 @@ pip install openai && python app.py
128130
Upload a file, create a vector store, and ask questions about it:
129131

130132
```python
133+
import httpx
131134
from openai import OpenAI
132135

133-
client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake")
136+
client = OpenAI(base_url="http://localhost:8321/v1", api_key="fake", http_client=httpx.Client(verify=False))
134137

135138
# Upload a document
136139
file = client.files.create(
@@ -166,7 +169,7 @@ That's it. Same OpenAI SDK, local model, your own vector store.
166169
If you see `Address already in use`, another process is using port 8321. Either stop it or run on a different port:
167170

168171
```bash
169-
uvx --from 'ogx[starter]' ogx run starter --port 8322
172+
uvx ogx go --port 8322
170173
```
171174

172175
</details>

docs/docs/index.mdx

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -113,11 +113,13 @@ curl -LsSf https://github.com/ogx-ai/ogx/raw/main/scripts/install.sh | bash
113113
pip install ogx
114114

115115
# Start the server
116-
ogx stack run
116+
uv run ogx go --insecure
117117
```
118118

119119
:::tip
120120
OGX works with any OpenAI-compatible client. Point your existing code at `http://localhost:8321/v1` and you're ready to go.
121+
122+
OGX is secure by default. `--insecure` forces the server to listen on http. By default it runs on https with a self-signed cert. You'll have to skip cert verification or trust the automatically generated cert.
121123
:::
122124

123125
[Quick Start Guide](/docs/getting_started/quickstart) | [OpenAI API Compatibility](./api-openai) | [GitHub](https://github.com/ogx-ai/ogx)

docs/src/components/InstallBlock/index.jsx

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,11 @@ import styles from './styles.module.css';
44
const EXAMPLES = [
55
{
66
label: 'Server',
7-
command: "uvx --from 'ogx[starter]' ogx run starter",
7+
command: "uvx ogx go",
88
tokens: [
99
{ text: 'uvx', style: 'tokenBinary' },
10-
{ text: '--from', style: 'tokenFlag' },
11-
{ text: "'ogx[starter]'", style: 'tokenPackage' },
1210
{ text: 'ogx', style: 'tokenCommand' },
13-
{ text: 'stack', style: 'tokenSub' },
14-
{ text: 'run', style: 'tokenSub' },
15-
{ text: 'starter', style: 'tokenAccent' },
11+
{ text: 'go', style: 'tokenSub' },
1612
],
1713
},
1814
{

0 commit comments

Comments
 (0)