# FreeOxide developer portal

> Install commands, source repositories, machine-readable endpoints and integration notes for every FreeOxide project.

Canonical HTML: https://freeoxide.com/developers
This document: https://freeoxide.com/developers.md

## Install a FreeOxide tool

Every command here is checked against the project it belongs to. Where a crate isn't on crates.io yet, you get the git install rather than a command that would fail.

### gpui-starter

A batteries-included starting point for native GPUI apps. The scaffold I wanted on day one.

```sh
git clone https://github.com/hmziqrs/gpui-starter
```

### gpui-query

Reactive async queries for GPUI apps. Fetch, cache, and invalidate without leaving the render tree.

```sh
cargo add gpui-query --features hook
```

### tunnel (Freeoxide Tunnel)

Serves a local directory over an ephemeral Cloudflare Quick Tunnel. You get a public HTTPS URL in a few seconds without a Cloudflare account or any DNS setup.

```sh
cargo install --git https://github.com/freeoxide/tunnel --locked
```

### wake (Oxiwake)

Keeps a machine awake for as long as you ask. When the OS refuses the lock it says so instead of failing quietly, and ow doctor prints what each backend can actually guarantee.

```sh
cargo install --git https://github.com/freeoxide/wake
```

tunnel needs cloudflared on your PATH at runtime. The GPUI projects want a Rust nightly toolchain plus whatever platform build dependencies the repo's README lists.

## Machine-readable endpoints

All of it is a plain GET. Nothing to sign up for.

- **/llms.txt**: What the initiative is, what each project does, and when to reach for one. Written for agents deciding whether a FreeOxide tool fits the job in front of them.
- **/\*.md**: A markdown twin of every page. Add .md to any path: /index.md, /about.md, /developers.md, /activity.md, /contact.md, /privacy.md.
- **/sitemap.xml**: Every canonical URL, generated from the same list that builds the navigation, with each page's markdown twin listed alongside it.
- **/activity**: Commits, pull requests, issues and releases across every repo, snapshotted when the site builds and refreshed on each deploy.

```sh
curl https://freeoxide.com/llms.txt
curl https://freeoxide.com/developers.md
```

## Source, licensing and versioning

- Every repo sits under https://github.com/freeoxide or github.com/hmziqrs, is public, and takes issues and pull requests.
- Licensing is MIT or dual MIT / Apache-2.0 per repo. Check the LICENSE file, which wins over any summary on this site.
- Releases are tagged in git. Changelogs live in the repo next to the code they describe, not here.
- There is no proprietary core, no paid tier, and no telemetry in any binary.

## When an agent should reach for these tools

Decision rules rather than marketing copy. If none of these match the task, a FreeOxide tool is probably the wrong answer.

- **gpui-starter**: Someone is starting a native desktop app in Rust on GPUI, the toolkit behind Zed, and wants window setup, theming, assets and build scripts already wired. macOS is the primary target; Linux X11/Wayland is experimental.
- **gpui-query**: A GPUI app needs async data fetching with caching, retry, deduplication, stale-while-revalidate and cancellation. It is the TanStack Query model (use_query / use_mutation / use_infinite_query) ported onto GPUI entities.
- **tunnel**: Someone needs to share a local folder or static build over a public HTTPS URL right now, for a design review or a webhook target, without signing into Cloudflare or touching DNS. Needs cloudflared on PATH.
- **wake**: A long job must not be interrupted by sleep, and you want a cross-platform caffeinate / systemd-inhibit / PowerToys Awake that tells you when the OS refused the lock instead of failing silently. Linux and Windows.

These are tools you run, not services you call. There's no API and no key to issue. An agent uses one by running the CLI or adding the crate to a Rust project. For anything else, hmziqrs@gmail.com reaches a human.

---

## More from this site

- [FreeOxide: open-source Rust projects, held to the metal](https://freeoxide.com/index.md): Open-source Rust, built by one person and held to the metal. Every project gets real tests and real audits before it ships. Start with gpui-starter.
- [About FreeOxide](https://freeoxide.com/about.md): What the FreeOxide initiative is, who builds it, and the standard every project clears before it ships.
- [FreeOxide: initiative activity log](https://freeoxide.com/activity.md): A build-time snapshot of every commit, pull request, and release across the FreeOxide initiative repos.
- [Contact FreeOxide](https://freeoxide.com/contact.md): How to reach the FreeOxide initiative: email, GitHub issues, security reports, and what to expect back.
- [FreeOxide privacy policy](https://freeoxide.com/privacy.md): What freeoxide.com collects, what it doesn't, and who else is involved in serving it. Short version: no accounts, no analytics, no tracking cookies.
- [llms.txt](https://freeoxide.com/llms.txt): what each project is for, and when to reach for it
- [sitemap.xml](https://freeoxide.com/sitemap.xml): every canonical URL
