Metadata-Version: 2.4
Name: ghostai-connect
Version: 0.0.1
Summary: Placeholder for the GhostAI Connect client: explains how to get it and checks that the GhostAI relay is reachable. Contains no client code.
Author-email: GhostAI <support@dymium.io>
License-Expression: MIT
Project-URL: Homepage, https://ghostai.dymium.io
Keywords: ghostai,connector,relay
Classifier: Development Status :: 1 - Planning
Classifier: Environment :: Console
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Dynamic: license-file

# ghostai-connect (placeholder)

This release holds the `ghostai-connect` name on PyPI for GhostAI. **It is not
the GhostAI Connect client** and contains none of its code. It cannot open a
tunnel.

GhostAI Connect is the small client a GhostAI customer runs next to their own
Ollama or vLLM server. It opens an outbound-only WebSocket connection to the
GhostAI relay, so no inbound firewall rule is needed.

## Getting the real client

Contact GhostAI at support@dymium.io, or ask your GhostAI administrator. The
client is provided as either:

- a wheel file: `pip install ./ghostai_connect-<version>-py3-none-any.whl`
- a signed container image, `ghcr.io/dymium-io/ghostai-connect` (access is
  granted by GhostAI). Verify it with `cosign verify` before you run it.

Then enroll it with the single-use token from the GhostAI admin console.

When the client is published here, `pip install --upgrade ghostai-connect`
replaces this placeholder.

## What this package does

```console
$ pip install ghostai-connect
$ ghostai-connect
```

It prints the instructions above, then checks that the GhostAI relay is
reachable from your network. The check sends one HTTPS request to
`relay-connector.alpha.dymium.io` with a 5-second timeout. It sends no
credentials and opens no connector session. It exits `0` when the relay is
reachable and `1` when it is not. Any other subcommand, such as `run` or
`enroll`, exits `2`.

| Option | Meaning |
|---|---|
| `--relay-url URL` | Check a different relay (default: `$GHOSTAI_CONNECT_RELAY_URL`, else `wss://relay-connector.alpha.dymium.io/connector/ws`) |
| `--timeout SECONDS` | How long to wait for the relay (default: 5) |
| `--no-check` | Print the instructions only, with no network access |
| `--version` | Print the version |

Python 3.8 or later, standard library only, no dependencies.

## License

MIT, for this placeholder's own code only. The license of the GhostAI Connect
client is set by that client's own releases.
