Skip to content

cli.md

Latest commit

 

History

History
241 lines (169 loc) · 6.66 KB

cli.md

File metadata and controls

241 lines (169 loc) · 6.66 KB
Raw

GoAccountHub CLI Documentation

GoAccountHub builds its command-line interface with urfave/cli v2. The following content is generated from the code in the cliAction/ directory.

🌐Language

English | 简体中文

  • App name: account_hub
  • App usage: account hub example

The examples below use the compiled binary name GoAccountHub (you may rename it or set an alias; it is referred to as gah in the README).

Command Overview

Command Description
start Start GoAccountHub
password Edit Root Admin Password
generate Generate Config File
generate-test Generate Test Config File

To view global help and version information:

GoAccountHub --help
GoAccountHub <command> --help

start

Start the GoAccountHub server. The same process serves both the REST API and the web UI that was embedded into the binary at compile time.

Usage

GoAccountHub start [options]

Options

Option Alias Default Description
--config -c config.json Config file path

Behavior

  1. Reads the configuration from the specified config file.
  2. Writes the frontend-related config to ./GAHFrontend/.env (created if missing): 
    PORT=<frontend_port>
VITE_API_PROXY_TARGET=http://127.0.0.1:<port>
  3. Starts the API server, and creates any missing database tables (AutoMigrate).
  4. Serves the embedded web UI (GAHFrontend/dist) on the same port, so http://localhost:<port> opens the admin frontend.

ℹ️ The .env file is only used by the Vite dev server (npm run dev). A production deployment does not need it: the Go process serves the UI itself.

⚠️ Run npm run build inside GAHFrontend before go build, otherwise the binary only contains the placeholder (GAHFrontend/public/.gitkeep is tracked so that a checkout still compiles; every frontend build copies it into GAHFrontend/dist). In that case the server answers with a "frontend is not embedded" hint instead of the UI.

Examples

GoAccountHub start
GoAccountHub start -c ./config.json

password

Edit the Root Admin password. The password is written to the config file as a SHA256 hash.

Usage

GoAccountHub password <password> [options]

Arguments

Argument Required Description
<password> Yes The new Root Admin password; if omitted, prints ⚠️ Password is Empty and makes no change

Options

Option Alias Default Description
--config -c ./config.json Config file path

Behavior

  1. Computes root_admin_password_hash = SHA256(password).
  2. Computes root_admin_uu_hash = SHA256("root" + passwordHash + Unix timestamp).
  3. Writes both fields back to the config file and prints ✅ Password is Updated.

Examples

GoAccountHub password your_password
GoAccountHub password your_password -c ./config.json

generate

Generate a blank config file.

Usage

GoAccountHub generate [options]

Options

Option Alias Default Description
--config -c ./config.json Config file path

Behavior

Serializes an empty Config struct and writes it to the target file. All fields are zero values and must be filled in manually.

Prints ✅ Config File is Generated on completion.

Examples

GoAccountHub generate
GoAccountHub generate -c ./config.json

generate-test

Generate a config file pre-filled with test data. The default Root Admin password is 123.

Usage

GoAccountHub generate-test [options]

Options

Option Alias Default Description
--config -c ./config.json Config file path

Behavior

Writes the following preset config:

Field Value
port 8080
database_name account_hub
database_host 127.0.0.1
database_port 3306
database_user postgres
database_password postgres
frontend_port (empty, fill it in manually)
root_admin_password_hash SHA256("123")
root_admin_uu_hash SHA256("root" + SHA256("123") + Unix timestamp)
switch_config.allow_multi_character false
switch_config.allow_admin_logout false

Prints ✅ Config File is Generated, Default Password is 123 on completion.

Examples

GoAccountHub generate-test

Config File Fields

The config file is in JSON format. The struct is defined in config/config.go.

{
    "port": "8081",
    "database_name": "GoAccountHub",
    "database_host": "127.0.0.1",
    "database_port": "5432",
    "database_user": "postgres",
    "database_password": "postgres",
    "frontend_port": "8082",
    "root_admin_password_hash": "a665a45920422f9d417......",
    "root_admin_uu_hash": "0fbaf45ee863c0......",
    "switch_config": {
        "allow_multi_character": true,
        "allow_admin_logout": false
    }
}
Field Type Description
port string API server port; it also serves the embedded web UI
database_name string Database name
database_host string Database host
database_port string Database port
database_user string Database username
database_password string Database password
frontend_port string Vite dev server port; written to GAHFrontend/.env when the server starts
root_admin_password_hash string Root Admin password hash, generated by password / generate-test; no need to set manually
root_admin_uu_hash string Root Admin unique hash, generated by the CLI; no need to set manually
switch_config object System switch config
switch_config.allow_multi_character bool Whether an account may have multiple characters
switch_config.allow_admin_logout bool Whether admin logout is allowed (implemented incorrectly, will be removed)

Typical Workflow

# 1. Generate the config file
GoAccountHub generate

# 2. Set the Root Admin password
GoAccountHub password <your_password>

# 3. Edit the config file and fill in database parameters etc. (see Config File Fields above)

# 4. Build the frontend and then the server (or just run `mage all`)
cd GAHFrontend && npm ci && npm run build && cd ..
go build -o GoAccountHub .

# 5. Start the server
GoAccountHub start

After the server starts, open http://localhost:<port> in a browser to use the admin frontend, and call the API under http://localhost:<port>/api/v1/.... The root admin password is the one set in step 2.