xueqiu-cli

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 15, 2026 License: Apache-2.0

README

xueqiu

A command line for Xueqiu stock community.

xueqiu is a single pure-Go binary. It reads public xueqiu data over plain HTTPS, shapes it into clean records, and prints output that pipes into the rest of your tools. No API key, nothing to run alongside it.

The same package is also a resource-URI driver, so a host program like ant can address xueqiu as xueqiu:// URIs.

Install

go install github.com/tamnd/xueqiu-cli/cmd/xueqiu@latest

Or grab a prebuilt binary from the releases, or run the container image:

docker run --rm ghcr.io/tamnd/xueqiu:latest --help

Usage

xueqiu page <path>                      # fetch one page as a record
xueqiu page <path> -o json              # as JSON, ready for jq
xueqiu page <path> --template '{{.Body}}'  # just the readable body text
xueqiu links <path>                     # the pages it links to, one per line
xueqiu --help                           # the whole command tree

Every command shares one output contract: -o table|json|jsonl|csv|tsv|url|raw, --fields to pick columns, --template for a custom line, and -n to limit. The default adapts to where output goes (a table on a terminal, JSONL in a pipe), so the same command reads well by hand and parses cleanly downstream.

This is a fresh scaffold. It ships one example resource type, page, wired end to end. Model the real xueqiu records in xueqiu/ and declare their operations in xueqiu/domain.go; each one becomes a command, an HTTP route, and an MCP tool at once.

Serve it

The same operations are available over HTTP and as an MCP tool set for agents, with no extra code:

xueqiu serve --addr :7777    # GET /v1/page/<path>  returns NDJSON
xueqiu mcp                   # speak MCP over stdio

Use it as a resource-URI driver

xueqiu registers a xueqiu domain the way a program registers a database driver with database/sql. A host enables it with one blank import:

import _ "github.com/tamnd/xueqiu-cli/xueqiu"

Then ant (or any program that links the package) dereferences xueqiu:// URIs without knowing anything about xueqiu:

ant get xueqiu://page/<path>   # fetch the record
ant cat xueqiu://page/<path>   # just the body text
ant ls  xueqiu://page/<path>   # the pages it links to, each addressable
ant url xueqiu://page/<path>   # the live https URL

Development

cmd/xueqiu/   thin main: hands cli.NewApp to kit.Run
cli/                 assembles the kit App from the xueqiu domain
xueqiu/                the library: HTTP client, data models, and domain.go (the driver)
docs/                tago documentation site
make build      # ./bin/xueqiu
make test       # go test ./...
make vet        # go vet ./...

Releasing

Push a version tag and GitHub Actions runs GoReleaser, which builds the archives, Linux packages, the multi-arch GHCR image, checksums, SBOMs, and a cosign signature:

git tag v0.1.0
git push --tags

The Homebrew and Scoop steps self-disable until their tokens exist, so the first release works with no extra secrets.

License

Apache-2.0. See LICENSE.

Directories

Path Synopsis
Package cli assembles the xueqiu command tree from the xueqiu domain on top of the any-cli/kit framework.
Package cli assembles the xueqiu command tree from the xueqiu domain on top of the any-cli/kit framework.
cmd
xueqiu command
Command xueqiu is a single-binary command line for xueqiu.
Command xueqiu is a single-binary command line for xueqiu.
Package xueqiu is the library behind the xueqiu command line: the HTTP client, request shaping, and the typed data models for xueqiu.
Package xueqiu is the library behind the xueqiu command line: the HTTP client, request shaping, and the typed data models for xueqiu.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL