LS Web CLI

CLI for LS Components Plus - query component knowledge, read docs, and get demos. Ships the component sources and docs inside the package, so the CLI/MCP work fully offline — no git clone, no network access needed.

Install

npm install -g @lingshugroup/ls-web-cli

Usage

ls-web-cli list                # list all components
ls-web-cli info button         # get Button props, events, slots, and exposes
ls-web-cli doc table           # read Table markdown docs
ls-web-cli demo form           # get Form code examples
ls-web-cli mcp                 # start MCP server for IDE integration

MCP Server news

Add to your IDE's MCP config (e.g. .mcp.json for Claude):

{
  "mcpServers": {
    "ls-web": {
      "command": "npx",
      "args": ["-y", "@lingshugroup/ls-web-cli", "mcp"]
    }
  }
}

Tools exposed:

| Tool | Description | |------|-------------| | ls_list | List all components | | ls_info | Get component props, events, slots, and exposes | | ls_doc | Read full markdown documentation | | ls_demo | Get demo code examples |

Prompts exposed:

| Prompt | Description | |--------|-------------| | ls-expert | LS Components Plus expert assistant | | ls-page-generator | Generate Vue 3 pages with LS components |

Data sources (offline by default)

The CLI/MCP reads LS Components Plus data (component sources + docs/demos) from the first location that exists:

1. --project <dir> flag or LS_COMPONENTS_PLUS_DIR environment variable
2. Bundled data shipped inside the installed package (data/ls-components-plus) — used by the published package, fully offline
3. A local ls-components-plus checkout next to the CLI repository
4. ~/.ls-web-cli/ls-components-plus cache (cloned on demand as a fallback, with a 120s timeout; configurable via LS_WEB_GIT_TIMEOUT_MS)

Development

npm install
npm run build
npm start -- list

The build step runs scripts/prepare-data.mjs, which copies the component sources and docs into data/ls-components-plus so they ship with the package. Data sources, in order of preference:

1. LS_COMPONENTS_SOURCE_DIR — point at a local ls-components-plus checkout (fully offline build)
2. .cache/ls-components-plus — an existing local clone (no network)
3. Shallow clone of LS_COMPONENTS_SOURCE_REPO (defaults to GitHub; set it to an internal mirror if needed)

License

MIT