maxit-cli
v1.2.0
Published
CLI et serveur MCP pour installer et documenter les composants o-* du design system Max it dans un mini-programme
Maintainers
Readme
maxit-cli.
npm login npm version patch && npm publish
Installe les composants o-* du design system Max it dans un mini-programme, avec leurs dépendances, comme ng generate component pour Angular.
maxit add button
maxit g c balance-card --page pages/home/homeInstallation
npm install -g maxit-cliOu sans installation :
npx maxit-cli add buttonNode 18 ou plus.
Commandes
| Commande | Effet |
|---|---|
| maxit init | Copie components/common et ajoute l'import des jetons dans app.wxss. Facultatif : add le fait aussi. |
| maxit add <nom>… | Copie les composants et tous les composants dont ils ont besoin dans components/, importe les jetons dans app.wxss, déclare o-<nom> dans app.json. |
| maxit generate component <nom> | Alias de add, aussi maxit g c <nom>. |
| maxit mcp | Démarre le serveur MCP pour les assistants IA (voir plus bas). |
| maxit list | Liste les 104 composants par catégorie ; ✓ = déjà dans le projet. --json pour une sortie JSON. |
Options de add :
--page pages/home/home: déclare le composant dans cette page plutôt que dansapp.json(le.jsonde la page est créé s'il manque).--no-register: ne déclare rien, affiche seulement la ligneusingComponentsà ajouter.--overwrite: remplace un dossier de composant déjà présent mais différent. Sans cette option, un composant modifié localement n'est jamais écrasé.--dry-run: montre ce qui serait fait sans rien écrire.--cwd <dossier>: projet cible, sinon le dossier courant. La CLI remonte jusqu'àapp.json(et suitminiprogramRootdeproject.config.json).
Les composants sont toujours installés dans <racine du mini-programme>/components/, car ils importent les jetons par le chemin absolu /components/common/style/tokens.wxss.
Serveur MCP pour Claude, Codex et autres assistants IA
maxit mcp est un serveur MCP (transport stdio) qui donne à l'assistant la documentation des composants et l'installateur. L'assistant sait alors quel composant choisir, quelles propriétés existent, et peut l'installer dans le projet.
Claude Code (pour tous vos projets ; --scope project pour l'écrire dans le .mcp.json du projet et le partager avec l'équipe) :
claude mcp add maxit --scope user -- npx -y maxit-cli mcpCodex CLI :
codex mcp add maxit -- npx -y maxit-cli mcpou dans ~/.codex/config.toml :
[mcp_servers.maxit]
command = "npx"
args = ["-y", "maxit-cli", "mcp"]Autres clients (Claude Desktop, Cursor, VS Code…) : même commande, npx avec les arguments -y maxit-cli mcp. Si maxit-cli est installé globalement, maxit mcp suffit.
Outils proposés :
| Outil | Rôle |
|---|---|
| get_guidelines | Règles d'installation, d'utilisation et de style des composants o-* (lib/guidelines.md). |
| list_components | Composants par catégorie. |
| search_components | Trouve un composant d'après un besoin (« solde », « reçu de transfert »…). |
| get_component | Documentation complète : installation, dépendances, propriétés, événements, slots, exemples WXML, API JS, historique. |
| get_design_tokens | Variables --o-* (couleurs, typographie, tailles) en clair et en sombre. |
| search_icons | Noms des 626 icônes Max it pour <o-maxit-icon>. |
| get_changelog | Journal des versions. |
| install_components | Lance maxit add dans le mini-programme (projectDir, page, overwrite, dryRun). Un composant modifié localement n'est jamais écrasé sans overwrite. |
La documentation servie vient de registry/docs.json, écrit par npm run sync à partir de mini-app-components (sources des composants, docs/scripts, tokens.wxss, CHANGELOG.md).
Essayer le serveur dans l'inspecteur MCP :
npx @modelcontextprotocol/inspector node bin/maxit.js mcpMettre à jour les composants embarqués
La CLI contient une copie des composants (registry/). Après une modification dans mini-app-components :
npm run sync # recopie mini-app-components/components, recalcule les dépendances, écrit registry/docs.json
npm test # essais de bout en bout de la CLI et du serveur MCP sur un mini-programme temporairenpm pack lance la synchronisation automatiquement. Les titres et catégories viennent de mini-app-components/docs/scripts/doc-data.js.
Versions
Le numéro de version de maxit-cli est celui de la bibliothèque : la première entrée de mini-app-components/CHANGELOG.md. npm run sync avertit si package.json n'est pas aligné. maxit --version et maxit list affichent la version des composants embarqués.
Licence
MIT. Les composants sont dérivés de TDesign Mini Program (MIT) : voir LICENSE.
