Skip to content

Update README for current Gortex HTTP server command #16

Description

@jantunes-te

Describe the bug

The README quick start instructs users to run gortex serve, but Gortex v0.63.1 does not support that command. The current Gortex server documentation uses daemon HTTP mode with gortex daemon start --http-addr 127.0.0.1:7411.

The README also defaults NEXT_PUBLIC_GORTEX_URL to http://localhost:4747, which does not match the documented daemon HTTP port.

To reproduce

  1. Install Gortex v0.63.1.
  2. Run gortex serve as documented in the README.
  3. See Error: unknown command "serve" for "gortex".

Expected behavior

The quick start uses a command supported by the current Gortex CLI and configures the Web UI for the same port.

Suggested README edit

-# 1. Start a gortex server in the repo you want to explore
-gortex serve                       # defaults to http://localhost:4747
+# 1. Track the repo and expose the daemon HTTP API
+gortex track /path/to/repo
+gortex daemon start --http-addr 127.0.0.1:7411

The bug report template contains the same stale gortex serve command and may need the same update.

Environment

  • OS: macOS
  • Gortex server version: v0.63.1+4f2d169
  • Web branch: main

References

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions