@xano/sdk 1.0.12 → 1.0.14
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +28 -0
- package/README.md +36 -36
- package/dist/.build-fingerprint +1 -1
- package/dist/{agent-file-refresh-YM5VRRHE.js → agent-file-refresh-3J6YRVFL.js} +12 -11
- package/dist/{agent-skill-command-GVVCBAGF.js → agent-skill-command-VWDMQWCT.js} +51 -50
- package/dist/{answer-shape-CBUQRSXI.js → answer-shape-AVZSKBR6.js} +4 -4
- package/dist/{backend-dir-NZOLU7TL.js → backend-dir-ISP7RVF2.js} +11 -10
- package/dist/{backend-slot-X5AUX2TT.js → backend-slot-DZAUHLTS.js} +3 -3
- package/dist/bin.js +47 -46
- package/dist/{branch-YS2K3VOB.js → branch-IJTBZZFO.js} +8 -8
- package/dist/{branch-commands-Q46PCVHU.js → branch-commands-75IYFTBS.js} +26 -25
- package/dist/{chunk-EMAFZROF.js → chunk-2FDHIBEU.js} +8 -8
- package/dist/{chunk-CPFWVB3V.js → chunk-2KOB4QPW.js} +13 -13
- package/dist/{chunk-PCHIHVX6.js → chunk-2LF734YB.js} +4 -4
- package/dist/{chunk-R7XZW4SB.js → chunk-3H7R4ISR.js} +2 -2
- package/dist/{chunk-ANBIMJPM.js → chunk-3SZ7QRYA.js} +36 -10
- package/dist/{chunk-DB7P2SSK.js → chunk-45K2QZBR.js} +3 -3
- package/dist/{chunk-C2SAVXAB.js → chunk-4MX5LMPQ.js} +2 -2
- package/dist/{chunk-IZI3SYXH.js → chunk-5FJ4M4HB.js} +38 -38
- package/dist/{chunk-LDSZPRGV.js → chunk-5TWLVFYB.js} +4 -4
- package/dist/{chunk-JKGRQW6D.js → chunk-5W7S2SCA.js} +4 -4
- package/dist/{chunk-F2NFNYCB.js → chunk-6ILHYSLR.js} +3 -3
- package/dist/{chunk-IFXPHVPY.js → chunk-6LJS4M6P.js} +3 -3
- package/dist/{chunk-CTUIMNEM.js → chunk-6X73VFCX.js} +2 -2
- package/dist/{chunk-DZUNF7IH.js → chunk-75QC66XI.js} +2 -2
- package/dist/{chunk-5SZSLAAC.js → chunk-7F3V6CFP.js} +3 -3
- package/dist/{chunk-2PAVJ3QD.js → chunk-B7CPSWQX.js} +7 -7
- package/dist/{chunk-4CS4DKQC.js → chunk-BEKEOXNG.js} +2 -2
- package/dist/{chunk-EC5P4W2D.js → chunk-BSGU4HS6.js} +44 -44
- package/dist/{chunk-U5CTYBAN.js → chunk-CB67GIR3.js} +26 -8
- package/dist/{chunk-M7DIIJPW.js → chunk-DBDTQR23.js} +4 -4
- package/dist/{chunk-5RSPMSSQ.js → chunk-DERQSEB5.js} +9 -9
- package/dist/{chunk-RZABQ4YH.js → chunk-DGYXCIBV.js} +4 -4
- package/dist/{chunk-BXVNRUDB.js → chunk-DLDYQNGP.js} +3 -3
- package/dist/{chunk-I2AVVARA.js → chunk-ECQXASG3.js} +2 -2
- package/dist/{chunk-2BHYGUTI.js → chunk-EQXHUWUO.js} +2 -2
- package/dist/{chunk-ONNSFD73.js → chunk-EYVIUX2T.js} +9 -9
- package/dist/{chunk-JFPLHK6Y.js → chunk-FBSGFPZ4.js} +2 -2
- package/dist/{chunk-EGEANMMK.js → chunk-FIERONKM.js} +2 -2
- package/dist/{chunk-K6BQPFRS.js → chunk-GBSHHNSD.js} +3 -3
- package/dist/{chunk-N3XSXGAL.js → chunk-GCINMMFL.js} +2 -2
- package/dist/{chunk-POZ6V4MU.js → chunk-GKQTXUOW.js} +2 -2
- package/dist/{chunk-HJSAGGHU.js → chunk-GOKRKTCX.js} +3 -3
- package/dist/{chunk-D4VKPOD4.js → chunk-GRXX2TOJ.js} +13 -112
- package/dist/{chunk-YJK4NPXC.js → chunk-GVHWIDEJ.js} +3 -3
- package/dist/{chunk-NZ7ML6LG.js → chunk-HINRE3UM.js} +5 -5
- package/dist/{chunk-OKR66IGL.js → chunk-HK554MDD.js} +7 -7
- package/dist/{chunk-WXLZCBPG.js → chunk-HKI5Y5KW.js} +14 -14
- package/dist/{chunk-HA5Y645X.js → chunk-HMYJOQXT.js} +23 -23
- package/dist/{chunk-DILYWJVP.js → chunk-HXFLHA5K.js} +2 -2
- package/dist/{chunk-A2AOUBJS.js → chunk-IHL2O7VY.js} +2 -2
- package/dist/{chunk-FLDFKG24.js → chunk-IKXXTRMN.js} +4 -4
- package/dist/{chunk-UZ55F3UK.js → chunk-IWJ6GFST.js} +4 -4
- package/dist/{chunk-AMHAGMJM.js → chunk-J3XLCYTQ.js} +80 -80
- package/dist/{chunk-2K2G5TSR.js → chunk-J62TYONQ.js} +3 -3
- package/dist/{chunk-MFEO3EHL.js → chunk-KDEU5FUJ.js} +3 -3
- package/dist/{chunk-VA4JK4TW.js → chunk-KMKUH2IO.js} +3 -3
- package/dist/{chunk-VTMTIBKP.js → chunk-L34DM6QB.js} +2 -2
- package/dist/{chunk-PBIV4DE2.js → chunk-L4WG4BKJ.js} +68 -68
- package/dist/{chunk-7XOQXZ6W.js → chunk-LB76VK6D.js} +7 -7
- package/dist/{chunk-E763QI3G.js → chunk-LJZIBT75.js} +2 -2
- package/dist/{chunk-ETMP7SJ3.js → chunk-LPQZICYN.js} +6 -6
- package/dist/{chunk-UFFIU57H.js → chunk-LSJ3SQEU.js} +4 -4
- package/dist/{chunk-RFB4EXM5.js → chunk-LW7TOIS7.js} +8 -8
- package/dist/{chunk-TOW4EJON.js → chunk-MAXDJZQR.js} +5 -5
- package/dist/{chunk-7NNLRNXE.js → chunk-MIS6F4HM.js} +4 -4
- package/dist/{chunk-WZXEQUIM.js → chunk-MTBKTGZT.js} +2 -2
- package/dist/{chunk-74NRFGL7.js → chunk-MYIIBV6A.js} +5 -5
- package/dist/{chunk-3RZ4UJWV.js → chunk-N6LGLNAC.js} +4 -4
- package/dist/{chunk-H7GMGZHI.js → chunk-NDV6CBR7.js} +2 -2
- package/dist/{chunk-RNVGXJJZ.js → chunk-NOW522B4.js} +13 -13
- package/dist/{chunk-DFCYAEBE.js → chunk-NUZXSIEA.js} +3 -3
- package/dist/{chunk-DYGRTWAI.js → chunk-O44MJTLR.js} +3 -3
- package/dist/{chunk-DH32QXVI.js → chunk-OLQN4Z5R.js} +53 -61
- package/dist/{chunk-2RDZDDPR.js → chunk-P4OWRYE7.js} +28 -28
- package/dist/{chunk-373AVIL2.js → chunk-QAEBBTYR.js} +7 -7
- package/dist/{chunk-6IOBEJWA.js → chunk-QJ25N4W6.js} +4 -4
- package/dist/{chunk-OK7CBTFW.js → chunk-QKHNJ7LE.js} +5 -5
- package/dist/{chunk-3ZVSOZZC.js → chunk-QRMKQYCB.js} +2 -2
- package/dist/{chunk-4GSXWOBS.js → chunk-QX5XQEYB.js} +5 -7
- package/dist/{chunk-4COXXP55.js → chunk-RDZBXTZ3.js} +4 -4
- package/dist/{chunk-U4DSFCH5.js → chunk-RPBB7P4Q.js} +2 -2
- package/dist/{chunk-W5MKVFBQ.js → chunk-RV2BDU7V.js} +5 -5
- package/dist/{chunk-XFQAA2SU.js → chunk-RVAEPPRH.js} +2 -2
- package/dist/{chunk-6QJORUHC.js → chunk-RYWNNJK5.js} +2 -2
- package/dist/{chunk-JPAUQ7MK.js → chunk-SAEIVQLP.js} +3 -3
- package/dist/{chunk-H5FAYLCR.js → chunk-SPLRKCFV.js} +2 -2
- package/dist/{chunk-3XZ44H2E.js → chunk-SUKO4SZG.js} +63 -55
- package/dist/{chunk-B5N6EWOM.js → chunk-UQ2OD7D4.js} +3 -3
- package/dist/{chunk-G3A3XKCS.js → chunk-VBSCWV5H.js} +49 -49
- package/dist/chunk-VYJYDMY6.js +9 -0
- package/dist/{chunk-C4TZP5PQ.js → chunk-WS2X5BB2.js} +5 -5
- package/dist/{chunk-P5JF3U65.js → chunk-WS4BA75E.js} +37 -4
- package/dist/{chunk-SAYHY2N3.js → chunk-XCFQLP6G.js} +8 -8
- package/dist/{chunk-OCNTMJSY.js → chunk-XPSDDTUZ.js} +3 -3
- package/dist/{chunk-OBRMA2VK.js → chunk-XY4OBD26.js} +3 -3
- package/dist/{chunk-XVOODRNK.js → chunk-Y5XAPLZS.js} +4 -4
- package/dist/{chunk-WQNN6WLB.js → chunk-YFQCDLCQ.js} +14 -14
- package/dist/{chunk-SAKWZG5I.js → chunk-YL3WVBR5.js} +9 -9
- package/dist/{chunk-XM56DAM7.js → chunk-YR3MNGWZ.js} +8 -8
- package/dist/{chunk-HUEFVPYW.js → chunk-YTQYP7UJ.js} +3 -3
- package/dist/{chunk-KICERNAP.js → chunk-Z3DQ7ULY.js} +4 -4
- package/dist/{chunk-JHQAVWHW.js → chunk-Z4BQPABS.js} +2 -2
- package/dist/{chunk-6LECAG3Y.js → chunk-ZMJRAMLA.js} +4 -4
- package/dist/{chunk-AUYXBKGR.js → chunk-ZOHEHIFS.js} +2 -2
- package/dist/{chunk-A3CT26GX.js → chunk-ZRXDPCMN.js} +2 -2
- package/dist/cli.js +45 -44
- package/dist/{codegen-command-H3HO7UFA.js → codegen-command-JWOW6HE5.js} +63 -62
- package/dist/codegen.js +2 -2
- package/dist/{commands-IFRAGWGK.js → commands-5ILSWDSV.js} +2 -2
- package/dist/{completion-RTXCODHS.js → completion-UNKBVVDT.js} +2 -2
- package/dist/{config-EHFXNFSP.js → config-NTOASFCA.js} +3 -3
- package/dist/{deploy-command-7PWQJ4VV.js → deploy-command-WESYWFJN.js} +52 -51
- package/dist/{deploy-source-CJHEVGOS.js → deploy-source-ZQQNMDFX.js} +27 -26
- package/dist/{dev-env-sync-VVLYQUPR.js → dev-env-sync-4XJT7WOT.js} +46 -45
- package/dist/{display-name-hint-BKPMISQU.js → display-name-hint-MYXCCAOP.js} +10 -10
- package/dist/{env-example-refresh-GLFC2FTE.js → env-example-refresh-4V2OCDJE.js} +64 -63
- package/dist/{env-pull-command-OY3SXNJC.js → env-pull-command-SK5FS477.js} +42 -41
- package/dist/{env-target-PDDDAA5I.js → env-target-TEFSYACA.js} +9 -9
- package/dist/{env-var-command-UTYDJN24.js → env-var-command-IJHKA2WJ.js} +37 -36
- package/dist/{ephemeral-CART6DIR.js → ephemeral-VLPRDNEJ.js} +8 -8
- package/dist/{ephemeral-command-ALIHUF7G.js → ephemeral-command-WCO5J4SN.js} +43 -42
- package/dist/{ephemeral-state-HPKSKC4Y.js → ephemeral-state-RUOU2GFS.js} +7 -7
- package/dist/{generate-command-S37XFYPD.js → generate-command-3WCOUOEQ.js} +68 -67
- package/dist/{gitignore-DKDWGWPS.js → gitignore-WYS3GMOX.js} +15 -14
- package/dist/{guards-RU4C7TFG.js → guards-PPIBIMFZ.js} +6 -6
- package/dist/{impersonate-command-HPCSKJAV.js → impersonate-command-UMYVQTCG.js} +33 -32
- package/dist/{import-RUBCGLCA.js → import-T4ZTOTBT.js} +4 -4
- package/dist/index.js +11 -11
- package/dist/{init-command-RWXBXJPG.js → init-command-UR5MSXIH.js} +50 -51
- package/dist/{init-modules-LFLW2PQC.js → init-modules-7KALFI5C.js} +7 -7
- package/dist/{init-web-OGKACAOC.js → init-web-DYE2FEXL.js} +2 -2
- package/dist/internal.js +72 -66
- package/dist/{keep-data-merge-7JGGZKDM.js → keep-data-merge-OVHCIEBG.js} +24 -24
- package/dist/{lambda-config-reconcile-FXPDH2U5.js → lambda-config-reconcile-VOBVZPWS.js} +3 -3
- package/dist/{landing-record-QJV7KNS4.js → landing-record-AIHNW4AZ.js} +17 -16
- package/dist/{live-diff-HARRGFV4.js → live-diff-UMSOGPX3.js} +6 -6
- package/dist/{local-engine-choice-NNSHE5FO.js → local-engine-choice-XDGTATKJ.js} +30 -29
- package/dist/{local-engine-command-UGIZ4UO6.js → local-engine-command-VQWNQ7UK.js} +35 -34
- package/dist/{local-engine-deploy-ZZVHBI2X.js → local-engine-deploy-4N4NFZ4T.js} +11 -11
- package/dist/{local-engine-lookup-QFRKO35F.js → local-engine-lookup-AQTUGSBT.js} +2 -2
- package/dist/{local-engine-mcp-bridge-T2EFRRAF.js → local-engine-mcp-bridge-AMYRH4SY.js} +9 -9
- package/dist/{local-engine-mcp-command-YUSZC7MF.js → local-engine-mcp-command-AIMNMXQG.js} +41 -48
- package/dist/{local-engine-process-XH35DURU.js → local-engine-process-OD5OSWDG.js} +6 -6
- package/dist/{local-engine-update-check-HAXE7BVG.js → local-engine-update-check-G3YCBXRE.js} +4 -4
- package/dist/{lock-commands-VT4R2DEE.js → lock-commands-H3YV2D6M.js} +50 -49
- package/dist/{login-command-4D3KPQUY.js → login-command-NMM3JNDZ.js} +23 -22
- package/dist/{logout-command-ALKHCJKS.js → logout-command-7DYC6G32.js} +13 -12
- package/dist/{loop-QHZD37KX.js → loop-DJNIHC7O.js} +6 -6
- package/dist/{marketplace-command-64TE2NGV.js → marketplace-command-UCSHDZGO.js} +33 -33
- package/dist/{marketplace-resolve-HPCRNV5O.js → marketplace-resolve-JR4BBJ6K.js} +5 -5
- package/dist/{meta-client-7MLLUZB4.js → meta-client-CD3TXQP6.js} +10 -10
- package/dist/{module-manifest-EFE6JBZW.js → module-manifest-63I5GRK4.js} +3 -3
- package/dist/node.js +50 -49
- package/dist/{operation-outcome-TYAOVNOM.js → operation-outcome-2ONIIDRU.js} +19 -19
- package/dist/{output-target-63ECBUX2.js → output-target-67LHZKCO.js} +16 -15
- package/dist/{plan-disclosure-WEMB5ZJ2.js → plan-disclosure-T7DF4SRJ.js} +16 -16
- package/dist/{plugin-contributions-U5PAZKBE.js → plugin-contributions-YYEP7IWH.js} +4 -4
- package/dist/{plugin-prompt-O5PAMV5B.js → plugin-prompt-GKCQKNYI.js} +4 -4
- package/dist/{plugin-questions-ZVYNKDRB.js → plugin-questions-P7MA3TYI.js} +3 -3
- package/dist/plugin.d.ts +2 -1
- package/dist/{preflight-command-OUVAX5IJ.js → preflight-command-TJ7FURXB.js} +56 -55
- package/dist/{profile-command-NUO5U2HQ.js → profile-command-LDPLTJEJ.js} +24 -23
- package/dist/{profile-pointer-VTOZDBHM.js → profile-pointer-JJ7K5O2R.js} +3 -3
- package/dist/{project-dependency-EZNTHMWI.js → project-dependency-X3KCWBK5.js} +6 -6
- package/dist/{project-sdk-ZGJM4WYQ.js → project-sdk-YHJZRCNB.js} +3 -3
- package/dist/promote-command-RURHOLNR.js +148 -0
- package/dist/{prompt-F7UVH4GP.js → prompt-QNMJIWNI.js} +3 -3
- package/dist/{publish-command-KVGNFBSU.js → publish-command-IIRN6NWN.js} +55 -54
- package/dist/{pull-command-OVXIMVUB.js → pull-command-ITO76ENU.js} +66 -65
- package/dist/{pull-superseded-77UZ7CHH.js → pull-superseded-6HADGGC5.js} +3 -3
- package/dist/{release-command-E54WUJKB.js → release-command-CVGIUD4M.js} +60 -59
- package/dist/{release-ns-command-SLRL3O3W.js → release-ns-command-YLCQPVH3.js} +78 -77
- package/dist/{retry-command-S5QALD5Z.js → retry-command-LFZYEVRU.js} +7 -7
- package/dist/{routes-manifest-ET2TTSCL.js → routes-manifest-R3TQRB24.js} +6 -6
- package/dist/{routes-manifest-file-IX4TOZCO.js → routes-manifest-file-GYNYFKAH.js} +9 -9
- package/dist/scaffold.d.ts +0 -5
- package/dist/scaffold.js +2 -2
- package/dist/{secrets-file-4NQWGCJG.js → secrets-file-PCNAFXNV.js} +15 -14
- package/dist/{secrets-fill-command-5NNHSYFX.js → secrets-fill-command-G7NQMRXU.js} +49 -48
- package/dist/{seed-5YLQRT2D.js → seed-4CD55LB4.js} +6 -6
- package/dist/{source-resolve-HSJSVKUC.js → source-resolve-U4SJR7ZA.js} +17 -17
- package/dist/{static-host-TQP3FXPI.js → static-host-MO4VDHL7.js} +4 -4
- package/dist/{status-command-UFIMW7SZ.js → status-command-CD72PXIT.js} +60 -34
- package/dist/{store-ZE5BXCOW.js → store-AJX4MC7Y.js} +5 -5
- package/dist/{sync-baseline-JGAAOS25.js → sync-baseline-BJDKG4F2.js} +7 -7
- package/dist/{sync-contributions-35ZAYBUH.js → sync-contributions-XK6LHISZ.js} +8 -8
- package/dist/{sync-record-ILWS44DG.js → sync-record-NE62ERA3.js} +9 -9
- package/dist/{table-V3LTQUY6.js → table-WPRAM4VW.js} +8 -8
- package/dist/{tables-command-TISOU6DR.js → tables-command-NMTKR52H.js} +35 -34
- package/dist/{tenant-7WUS7Q6V.js → tenant-IIYECNWO.js} +9 -9
- package/dist/{tenant-command-ITCPN43T.js → tenant-command-XQAWT46C.js} +83 -82
- package/dist/{test-command-7SFAJ6HX.js → test-command-W4AD4KT4.js} +32 -31
- package/dist/{tests-ENFUACKD.js → tests-JWQRHFCT.js} +5 -5
- package/dist/{token-OXGOA6WE.js → token-P3VQ6ITJ.js} +9 -8
- package/dist/{toolchain-hooks-QIFGPGH2.js → toolchain-hooks-UAJBPSTC.js} +8 -8
- package/dist/{toolchain-modules-Q3Z6APPF.js → toolchain-modules-S3MPHCUI.js} +4 -4
- package/dist/{toolchain-peers-K44IINPG.js → toolchain-peers-FQJBTKEB.js} +7 -7
- package/dist/{tracked-backend-IYTIZZYV.js → tracked-backend-WWEPNUD5.js} +30 -29
- package/dist/{update-check-LSCQRDRR.js → update-check-O7QC5TBB.js} +48 -47
- package/dist/{upgrade-command-RQEQJO5Y.js → upgrade-command-J6LRNHYF.js} +51 -50
- package/dist/{whoami-command-NT3FVBZM.js → whoami-command-KWRP2CII.js} +12 -11
- package/dist/{workspace-5RHOJC7K.js → workspace-3YNK4XO4.js} +4 -4
- package/dist/{workspace-binding-YUU6KB53.js → workspace-binding-TTDNXHO5.js} +11 -10
- package/dist/{workspace-command-QSJHX5RS.js → workspace-command-W4ANGLCZ.js} +79 -78
- package/dist/{workspace-env-M7RYVJB3.js → workspace-env-6LJGCTZA.js} +12 -11
- package/dist/{workspace-export-GHMUSX2P.js → workspace-export-PUEXKZNS.js} +4 -4
- package/dist/{writable-Y6CE2CGK.js → writable-LMMG4AFZ.js} +3 -3
- package/dist/{xano-2A2GT7EH.js → xano-Z3SRHYOR.js} +7 -7
- package/dist/{xanosdk-import-4TLNYFKC.js → xanosdk-import-PNNMZ4SF.js} +5 -5
- package/dist/{xanosdk-project-4NH6332J.js → xanosdk-project-YW3BQY2E.js} +13 -12
- package/guides/README.md +3 -3
- package/guides/authoring.md +24 -18
- package/guides/bundle.md +2 -2
- package/guides/cli.md +204 -191
- package/guides/codegen.md +20 -19
- package/guides/codes.md +3 -3
- package/guides/coverage.md +5 -4
- package/guides/deploying.md +140 -133
- package/guides/environment.md +38 -38
- package/guides/marketplace.md +35 -29
- package/guides/module-contract.md +20 -15
- package/guides/object-kinds.md +12 -9
- package/guides/project-structure.md +4 -4
- package/guides/scaffold.md +44 -32
- package/guides/typed-frontend.md +10 -9
- package/llms/client.md +4 -4
- package/llms/errors.md +2 -2
- package/llms/fields.md +1 -1
- package/llms/kinds-agent-mcp.md +1 -1
- package/llms/kinds-knowledge.md +2 -2
- package/llms/kinds-realtime.md +2 -2
- package/llms/lock.md +3 -3
- package/llms/object-kinds.md +2 -2
- package/llms/statements-calls.md +1 -1
- package/llms/statements-runtime.md +2 -2
- package/llms/tests.md +3 -3
- package/llms/toolchain.md +2 -2
- package/llms-full.txt +61 -58
- package/llms.txt +36 -33
- package/manifest.json +2 -2
- package/package.json +1 -1
- package/skills/xano-backend/SKILL.md +7 -7
- package/dist/promote-command-MGLAYQDY.js +0 -147
package/guides/scaffold.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# The scaffolded project
|
|
2
2
|
|
|
3
|
-
What `
|
|
3
|
+
What `npx @xano/sdk init` writes, the two frontend presets, a project with no frontend, adding the backend to an existing app, theming, add-ons, and the SvelteKit prerendering rules.
|
|
4
4
|
|
|
5
5
|
## init flags and add-ons
|
|
6
6
|
|
|
@@ -9,7 +9,10 @@ backend alone — see [No frontend, and existing apps](#no-frontend-and-existing
|
|
|
9
9
|
(default: the folder name), `--theme <id>` / `--radius <len>` / `--dark <mode>` /
|
|
10
10
|
`--font <id>` / `--font-mono <id>` / `--font-heading <id>` / `--icons <id>`
|
|
11
11
|
(the look — see [Theming](#theming)), `--no-agents-md` (skip the `AGENTS.md`
|
|
12
|
-
agent brief, which every coding agent reads and `init` writes by default
|
|
12
|
+
agent brief, which every coding agent reads and `init` writes by default, and the
|
|
13
|
+
`.mcp.json` / `.cursor/mcp.json` configs that connect agents to the `xano-local`
|
|
14
|
+
MCP server), `--ai <preset|none>` (for scripted callers: `none` is `--no-agents-md`, and
|
|
15
|
+
any other value writes the one `AGENTS.md` every agent reads),
|
|
13
16
|
`--marketplace <pkg>` (repeatable, comma-separated; installs add-ons and
|
|
14
17
|
registers them — below), `--force` (write over what clashes when adding the backend to
|
|
15
18
|
a non-empty folder; it lists the files and scripts it would overwrite and asks, `--yes`
|
|
@@ -31,10 +34,10 @@ A scaffold ships `@xano/sdk` and nothing else from the `@xano-sdk` scope. Add-on
|
|
|
31
34
|
install on demand:
|
|
32
35
|
|
|
33
36
|
```bash
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
37
|
+
npx @xano/sdk marketplace list # every published add-on
|
|
38
|
+
npx @xano/sdk marketplace search auth # …or narrow by keyword
|
|
39
|
+
npx @xano/sdk marketplace details @xano-sdk/auth # what it installs + how to register it
|
|
40
|
+
npx @xano/sdk marketplace install @xano-sdk/auth # add it to the project you're in
|
|
38
41
|
```
|
|
39
42
|
|
|
40
43
|
The three read verbs hit a public catalogue, so they work before you log in.
|
|
@@ -46,7 +49,7 @@ verbs, what each one does to a project, and how an add-on is configured.
|
|
|
46
49
|
add-ons already wired:
|
|
47
50
|
|
|
48
51
|
```bash
|
|
49
|
-
|
|
52
|
+
npx @xano/sdk init my-app --framework react --marketplace @xano-sdk/auth,@xano-sdk/vector
|
|
50
53
|
```
|
|
51
54
|
|
|
52
55
|
That installs each package **and** writes its registration into `xano/index.ts`.
|
|
@@ -64,7 +67,7 @@ have the value. A scaffold that compiles with an add-on switched off beats one
|
|
|
64
67
|
that does not compile at all.
|
|
65
68
|
|
|
66
69
|
Each `--marketplace` name is resolved through the marketplace first, exactly as
|
|
67
|
-
`
|
|
70
|
+
`npx @xano/sdk marketplace install` resolves it: a module's package or its slug
|
|
68
71
|
(`--marketplace auth` installs `@xano-sdk/auth`, never npm's unrelated `auth`). A
|
|
69
72
|
name the marketplace does not list stops `init` with **exit 8** before it writes
|
|
70
73
|
anything. So does a package name the npm registry does not have — the same rule
|
|
@@ -109,11 +112,12 @@ the add-on puts on your workspace, what you have to supply, and the
|
|
|
109
112
|
`xano/index.ts` registration to copy. Piped, it emits JSON; `--prompt` emits
|
|
110
113
|
instructions written to be handed straight to a coding agent.
|
|
111
114
|
|
|
112
|
-
|
|
113
|
-
|
|
114
|
-
|
|
115
|
-
|
|
116
|
-
and
|
|
115
|
+
`install` resolves its argument through the marketplace before npm runs — a module's
|
|
116
|
+
package or its slug (`auth`), keeping any version or tag — and refuses a name the
|
|
117
|
+
marketplace does not list with **exit 8**; local paths, `file:`, tarball and git specs
|
|
118
|
+
install as given. It also refuses before npm runs when you are not standing in a project,
|
|
119
|
+
and reconciles afterwards, asking any toolchain module that arrived its questions. See
|
|
120
|
+
[Installing](marketplace.md#installing).
|
|
117
121
|
|
|
118
122
|
## No frontend, and existing apps
|
|
119
123
|
|
|
@@ -123,7 +127,8 @@ is a **new** project, and `--framework` decides its frontend. Any other director
|
|
|
123
127
|
|
|
124
128
|
**A new project with `--framework none`** (or "No frontend" at the prompt) gets everything
|
|
125
129
|
above except the frontend: `xano/`, a `package.json` with only the backend's scripts and
|
|
126
|
-
dependencies, `.gitignore`, `.gitattributes`, the CI check, a README
|
|
130
|
+
dependencies, `.gitignore`, `.gitattributes`, the CI check, a README, `AGENTS.md`, and the
|
|
131
|
+
`.mcp.json` / `.cursor/mcp.json` agent configs. There is
|
|
127
132
|
no `frontend/` and no root `tsconfig.json`; `xano/` type-checks under its own
|
|
128
133
|
`xano/tsconfig.json`, and `npm run xano:typecheck` checks it and its lambdas.
|
|
129
134
|
`xano:deploy:ephemeral` deploys the backend alone, and there is no `dev`, `build` or
|
|
@@ -143,6 +148,11 @@ no `frontend/` and no root `tsconfig.json`; `xano/` type-checks under its own
|
|
|
143
148
|
- A marked block in `.gitignore` (created when missing) and in `AGENTS.md`, added or
|
|
144
149
|
refreshed in place; the rest of each file is left as it was. A symlinked `AGENTS.md` is left
|
|
145
150
|
alone, and `--no-agents-md` skips it.
|
|
151
|
+
- The `xano-local` MCP server merged by key into `.mcp.json` and `.cursor/mcp.json` (created
|
|
152
|
+
when missing): the other servers a config declares are kept. A config that already declares
|
|
153
|
+
`xano-local`, or is not valid JSON, is left alone and is not a clash; a symlinked one is
|
|
154
|
+
skipped. `--no-agents-md` skips both. See
|
|
155
|
+
[Connecting a coding agent](deploying.md#connecting-a-coding-agent).
|
|
146
156
|
- No frontend, README, CI workflow or root `tsconfig.json`. The line-ending rule goes in
|
|
147
157
|
`xano/.gitattributes`, scoped to `xano/`, so the project's own files are not renormalized.
|
|
148
158
|
|
|
@@ -177,17 +187,19 @@ The workflow installs with the project's package manager (npm, pnpm, yarn or bun
|
|
|
177
187
|
`init` detected it), frozen to the committed lockfile, then runs `xano:check` on every push
|
|
178
188
|
and pull request. In a monorepo workspace member it installs at the workspace root and checks
|
|
179
189
|
in the member's directory; move the file to the repository root's `.github/workflows/`, the
|
|
180
|
-
only place GitHub reads it. That script
|
|
181
|
-
|
|
190
|
+
only place GitHub reads it. That script runs three steps in order:
|
|
191
|
+
`npx @xano/sdk routes ./xano/index.ts --emit xano/routes.gen.ts --strict`, which fails when the
|
|
192
|
+
committed route manifest the frontend takes its paths from is stale or missing; the project's
|
|
193
|
+
typecheck (`tsc` on React, `svelte-kit sync && svelte-check` on Svelte, `tsc -p xano` with no
|
|
194
|
+
frontend, each followed by `tsc -p xano/lambdas`); and
|
|
195
|
+
`npx @xano/sdk export ./xano/index.ts --check --strict`: every check an export runs (a build warning fails it), under
|
|
182
196
|
`--frozen-lock`, writing nothing — no bundle, no lock. Because nothing is written, it
|
|
183
197
|
reads no `xano/.env` or `xano/.secrets.json`, so the workflow needs no repository
|
|
184
198
|
secrets, even for an API group whose docs are token-gated. It fails instead of
|
|
185
199
|
rewriting when `xano.lock` disagrees with the source, naming what would change. A
|
|
186
200
|
project with nothing to record yet (a fresh scaffold) passes without a lock. It also fails while the lock
|
|
187
201
|
carries an entry no exported object matches — the state a rename leaves until
|
|
188
|
-
`lock rename` moves the identity across, or `lock prune` drops it.
|
|
189
|
-
`xanosdk routes ./xano/index.ts --emit xano/routes.gen.ts --strict`, which fails when
|
|
190
|
-
the committed route manifest the frontend takes its paths from is stale or missing.
|
|
202
|
+
`lock rename` moves the identity across, or `lock prune` drops it.
|
|
191
203
|
`dev`, `build` and `typecheck` regenerate that file, so after adding or renaming an
|
|
192
204
|
endpoint run `npm run xano:routes` (or any of them) and commit it. `init --from` and
|
|
193
205
|
`pull` write it with the decoded backend, and `init --marketplace` writes it (and
|
|
@@ -215,17 +227,17 @@ project's `package.json` under `"xanosdk"`, keyed by package name, so a choice m
|
|
|
215
227
|
once survives to every later run.
|
|
216
228
|
|
|
217
229
|
Those questions are asked wherever the project is reconciled — at `init`, and in a
|
|
218
|
-
project that already exists. **`
|
|
230
|
+
project that already exists. **`npx @xano/sdk marketplace install <package>` is not just
|
|
219
231
|
`npm install`:** it runs the module's questionnaire and writes both its settings and
|
|
220
232
|
the `.gitattributes` lines it contributes. A module that arrived any other way — a
|
|
221
233
|
plain `npm install`, a merged pull request, a `git pull` that changed
|
|
222
|
-
`package.json` — is configured by running `
|
|
234
|
+
`package.json` — is configured by running `npx @xano/sdk marketplace install` on it; until
|
|
223
235
|
then `export` and `deploy` report it as installed but never configured, and it runs
|
|
224
236
|
on its own defaults.
|
|
225
237
|
|
|
226
|
-
**`
|
|
238
|
+
**`npx @xano/sdk marketplace reinstall <package>`** re-asks the questions, offering this
|
|
227
239
|
project's current settings as the defaults, and switches a module back on if it was
|
|
228
|
-
turned off. **`
|
|
240
|
+
turned off. **`npx @xano/sdk marketplace remove <package>`** uninstalls it and drops its
|
|
229
241
|
settings and its contributed lines together. A plain `npm uninstall` leaves the
|
|
230
242
|
`"xanosdk"` block behind, and a package that block names but that is no longer
|
|
231
243
|
installed fails every `--frozen-lock` run until you run `reinstall` or `remove`.
|
|
@@ -247,14 +259,14 @@ Writing one is [The module contract](module-contract.md): the manifest fields, t
|
|
|
247
259
|
command line:
|
|
248
260
|
|
|
249
261
|
```bash
|
|
250
|
-
|
|
262
|
+
npx @xano/sdk init my-app --web
|
|
251
263
|
```
|
|
252
264
|
|
|
253
265
|
It is a launcher, not a second scaffolder: a configurator is downloaded on
|
|
254
266
|
demand, serves a local page, and finishes by running `init` with the flags your
|
|
255
267
|
choices imply — printing the equivalent command so the project stays
|
|
256
268
|
reproducible from a script. Everything after `--web` is passed to it untouched,
|
|
257
|
-
including `--help`, which is why that one form reaches the network. `
|
|
269
|
+
including `--help`, which is why that one form reaches the network. `npx @xano/sdk help
|
|
258
270
|
init` stays offline, like `init` itself.
|
|
259
271
|
|
|
260
272
|
Because the configurator is fetched at run time, `--web` needs the npm registry
|
|
@@ -267,7 +279,7 @@ into `xano/index.ts` by hand after `npm install`.
|
|
|
267
279
|
|
|
268
280
|
To point `npm run dev` at a real backend, copy `.env.example` to `.env.local` — both
|
|
269
281
|
live at the **project root**, next to `vite.config.ts` — and set `VITE_XANO_HOST` to a
|
|
270
|
-
deployed URL. Deployed builds don't need it: `
|
|
282
|
+
deployed URL. Deployed builds don't need it: `npx @xano/sdk deploy <entry> --static <dir>` injects the
|
|
271
283
|
backend URL as `window.XANO_HOST`, which takes precedence.
|
|
272
284
|
|
|
273
285
|
The frontend ships `Button` and `Card` already vendored, plus a pre-configured
|
|
@@ -289,9 +301,9 @@ and there is no `tailwind.config.js`. That one stylesheet backs both frameworks.
|
|
|
289
301
|
`init` renders it from a theme you choose, using shadcn's own two-part model:
|
|
290
302
|
|
|
291
303
|
```bash
|
|
292
|
-
|
|
293
|
-
|
|
294
|
-
|
|
304
|
+
npx @xano/sdk init my-app --theme zinc-blue # a base color, plus an accent over it
|
|
305
|
+
npx @xano/sdk init my-app --theme stone # a base color alone
|
|
306
|
+
npx @xano/sdk init my-app --theme zinc --radius 0
|
|
295
307
|
```
|
|
296
308
|
|
|
297
309
|
Base colors — the full token set: `neutral` (default), `stone`, `zinc`, `mauve`,
|
|
@@ -305,8 +317,8 @@ the chart ramp, and the sidebar primary: `amber`, `blue`, `cyan`, `emerald`,
|
|
|
305
317
|
generator's, or your team's:
|
|
306
318
|
|
|
307
319
|
```bash
|
|
308
|
-
|
|
309
|
-
|
|
320
|
+
npx @xano/sdk init my-app --theme https://ui.shadcn.com/r/themes/slate.json
|
|
321
|
+
npx @xano/sdk init my-app --theme ./brand-theme.json
|
|
310
322
|
```
|
|
311
323
|
|
|
312
324
|
`--radius <len>` overrides the corner radius (a bare number is rem). Everything
|
|
@@ -337,7 +349,7 @@ on every page load of your app, a failure behind a firewall, and a privacy
|
|
|
337
349
|
question someone inherits later.
|
|
338
350
|
|
|
339
351
|
```bash
|
|
340
|
-
|
|
352
|
+
npx @xano/sdk init my-app --font geist --font-heading instrument-serif --icons tabler
|
|
341
353
|
```
|
|
342
354
|
|
|
343
355
|
- `--font <id>` — body text (Tailwind's `--font-sans`, which v4 also uses as the
|
package/guides/typed-frontend.md
CHANGED
|
@@ -36,6 +36,9 @@ Every type and helper a frontend gets from a deployed def — path resolution, i
|
|
|
36
36
|
one group and verb that a single path can reach (`query.route-shadowed`). Make the paths
|
|
37
37
|
disjoint (`"runs/by-id/{id}"`), or declare a numeric param `input.int({ required: true })`:
|
|
38
38
|
only a REQUIRED int/decimal segment matches digits only, and an optional one matches any text.
|
|
39
|
+
|
|
40
|
+
## Inferring the response type
|
|
41
|
+
|
|
39
42
|
- **`InferRow<typeof post>`** → the table's row type. Rename or retype a column and every
|
|
40
43
|
consumer breaks at compile time — exactly where you want it.
|
|
41
44
|
- **`InferResponse<typeof someQuery>`** → the endpoint's **response** type, closing the round
|
|
@@ -46,9 +49,6 @@ Every type and helper a frontend gets from a deployed def — path resolution, i
|
|
|
46
49
|
yielding null — `NotFound`/404 for `edit`/`patch`, a unique-constraint error for `add`, while
|
|
47
50
|
`add_or_edit` upserts and never misses), `Row | null` for `db.get` (it binds
|
|
48
51
|
`null` on a miss rather than throwing — handle the not-found path), a row list for
|
|
49
|
-
|
|
50
|
-
## Inferring the response type
|
|
51
|
-
|
|
52
52
|
`db.query`/`db.bulk.patch` (→ `Row[]`), a `boolean` for `db.has`, a `number` count for
|
|
53
53
|
`db.bulk.delete`, and a `get`/`query` `output: [...]` selection narrows to a `Pick` (still
|
|
54
54
|
`| null` for `get`). A dotted entry selects sub-keys of an object column
|
|
@@ -64,7 +64,7 @@ Every type and helper a frontend gets from a deployed def — path resolution, i
|
|
|
64
64
|
`response: { user: obj({ id: ref("row.id") }) }` and the raw literal
|
|
65
65
|
`response: { user: { id: ref("row.id") } }` both derive `{ user: { id: number | null } }`.
|
|
66
66
|
A **call** carries the shape across: `s.function.call`/`s.function.run`, `s.tool.call` and
|
|
67
|
-
`s.api.call` (workflow-test only
|
|
67
|
+
`s.api.call` (workflow-test only — see [Object kinds](object-kinds.md)) given a def **handle** bind their `as` with the
|
|
68
68
|
target's own `InferResponse`,
|
|
69
69
|
so `ref("discount_result.discount_cents")` in the caller types to that field instead of
|
|
70
70
|
`unknown`. What the target resolves to is what propagates, so declaring `responseShape` on
|
|
@@ -89,7 +89,7 @@ For a **computed or multi-key object response**, author it as a *record of value
|
|
|
89
89
|
`response: { success: c.bool(true), id: inp("id") }` — **not** `c.obj({ ... })`. `c.obj` builds a
|
|
90
90
|
*constant*, so a tagged value nested inside it would serialize as internal representation the
|
|
91
91
|
engine can't decode (a runtime 500); nesting one is now a compile error that points you at the
|
|
92
|
-
record form
|
|
92
|
+
record form. A **nested plain object** in a record
|
|
93
93
|
response (`response: { user: { id: ref("u"), age: 3 } }`) is auto-wrapped for you — no manual
|
|
94
94
|
`obj({ ... })` — and raw literals in a call/agent `input` map coerce too
|
|
95
95
|
(`s.function.run({ fn, input: { max_age_days: 3 } })` — no `c.int(3)`).
|
|
@@ -179,7 +179,7 @@ is paid by importing any def at all.
|
|
|
179
179
|
almost no bundle cost:
|
|
180
180
|
|
|
181
181
|
```bash
|
|
182
|
-
|
|
182
|
+
npx @xano/sdk routes ./xano/index.ts --emit xano/routes.gen.ts
|
|
183
183
|
```
|
|
184
184
|
|
|
185
185
|
The emitted file is plain data plus one interpolator and imports nothing at all — the same
|
|
@@ -249,8 +249,9 @@ import { mcpUrl } from "../xano/routes.gen";
|
|
|
249
249
|
const connectUrl = mcpUrl("notes_mcp", XANO_HOST); // https://host/x2/mcp/<canonical>/mcp/stream
|
|
250
250
|
```
|
|
251
251
|
|
|
252
|
-
Run `
|
|
253
|
-
each route, socket, channel and MCP server
|
|
252
|
+
Run `npx @xano/sdk routes ./xano/index.ts` without `--emit` to see every address the file carries:
|
|
253
|
+
each route in its `api:<canonical>/<name>` form, and each socket, channel and MCP server with
|
|
254
|
+
the call that builds it.
|
|
254
255
|
|
|
255
256
|
**Request types come from the same file.** It exports four types-only maps, keyed exactly
|
|
256
257
|
like the runtime tables they sit beside, so a frontend types what it sends without importing a
|
|
@@ -283,7 +284,7 @@ manifest types it as the linked table's columns, which is what the server accept
|
|
|
283
284
|
type them with `InferResponse` on an `import type` of the def.
|
|
284
285
|
|
|
285
286
|
These are types, so they add nothing to a bundle. For runtime validation, install
|
|
286
|
-
`@xano-sdk/zod` (`npx
|
|
287
|
+
`@xano-sdk/zod` (`npx @xano/sdk marketplace install zod`): it writes `ROUTE_SCHEMAS`,
|
|
287
288
|
`CHANNEL_SCHEMAS` and `MESSAGE_SCHEMAS` into the same file under the same keys
|
|
288
289
|
(`ROUTE_SCHEMAS["POST listings"].parse(body)`), each checked against its type when you
|
|
289
290
|
typecheck, so a schema cannot drift from the type it validates. The file then imports `zod`,
|
package/llms/client.md
CHANGED
|
@@ -11,7 +11,7 @@ Importing a def into a browser bundle or a Node script — for `getPath()`, `get
|
|
|
11
11
|
⚠ A FLOOR — **~267 kB minified (~65 kB gzipped)** for the FIRST def; splitting modules
|
|
12
12
|
never removes it. The floor is the RUNTIME, not the def: a second or much richer def
|
|
13
13
|
adds ~2 kB, so trimming a def does not shrink it.
|
|
14
|
-
Fix: `
|
|
14
|
+
Fix: `npx @xano/sdk routes <entry> --emit xano/routes.gen.ts` (`paths` is an accepted alias) — verbs, paths, and sockets as
|
|
15
15
|
plain data importing NOTHING, still compile-checked: `routePath("GET blog/{slug}", { slug })`
|
|
16
16
|
`channelPath("rooms/{room_id}", { room_id })`, `socketUrl("chat", baseUrl)` (tenant base
|
|
17
17
|
URLs lifted to `wss://h/ws/<tenant>:<canonical>`), `mcpUrl("notes_mcp", baseUrl)` (an MCP
|
|
@@ -23,7 +23,7 @@ Importing a def into a browser bundle or a Node script — for `getPath()`, `get
|
|
|
23
23
|
keep `InferInput` in code that already imports defs. They match `InferInput`, except a
|
|
24
24
|
`dbLink` input appears as the linked table's columns (what the server accepts). Responses
|
|
25
25
|
are not in the file: `InferResponse` on an `import type` of the def.
|
|
26
|
-
Runtime validation: `
|
|
26
|
+
Runtime validation: `npx @xano/sdk marketplace install zod` adds `@xano-sdk/zod`, which writes
|
|
27
27
|
`ROUTE_SCHEMAS`/`CHANNEL_SCHEMAS`/`MESSAGE_SCHEMAS` into the file under the same keys, each
|
|
28
28
|
checked against its type at typecheck; the file then imports `zod`, never `@xano/sdk`.
|
|
29
29
|
- **Verifying a def outside a bundler.** Inside a bundler (Vite/webpack) importing a
|
|
@@ -34,7 +34,7 @@ Importing a def into a browser bundle or a Node script — for `getPath()`, `get
|
|
|
34
34
|
xanosdk CLI's own loader resolves). Running from outside the project root also breaks
|
|
35
35
|
the `@xano/sdk` specifier resolution.
|
|
36
36
|
|
|
37
|
-
**Reading the injected backend URL.** `
|
|
37
|
+
**Reading the injected backend URL.** `npx @xano/sdk deploy <entry> --static <dir>` writes the deployed env's URL
|
|
38
38
|
into every html document: a prerendered build serves a different one per
|
|
39
39
|
route, and a route without the global renders fine while every call goes to the wrong
|
|
40
40
|
origin. Read it at runtime with a build-time fallback:
|
|
@@ -49,7 +49,7 @@ host falls back to '', and every call 404s off the dev server.
|
|
|
49
49
|
⚠ It is INJECTED in bracket form — `window["XANO_HOST"]="…"` — so verifying a deploy
|
|
50
50
|
by grepping `window.XANO_HOST` matches nothing and reads as a failed inject. Grep the
|
|
51
51
|
bare `XANO_HOST` token.
|
|
52
|
-
**Frontend without the backend.** `
|
|
52
|
+
**Frontend without the backend.** `npx @xano/sdk publish <dir> [--to <backend>]` uploads an
|
|
53
53
|
already-built directory and nothing else — no compile, no import (scaffold script
|
|
54
54
|
`npm run xano:deploy:frontend`). A Xano Engine (`--to local`, or bare after a local
|
|
55
55
|
deploy) serves it, server half included, at `http://<prefix>.localhost:<port>`.
|
package/llms/errors.md
CHANGED
|
@@ -37,7 +37,7 @@
|
|
|
37
37
|
- `ERR_PACKAGE_PATH_NOT_EXPORTED` — `tsx -e "import …"`, or running from outside the project root; run a real file with `tsx <file.ts>` from the root. `llms/client.md`.
|
|
38
38
|
- `Missing statement: mvp:placeholder` on import — an unconfigured slot in a pulled tree; replace it with the statement it stands in for. `llms/legacy.md`.
|
|
39
39
|
- A CLI command fails under `--json` or piped (unless stdout carries data): stdout is `{ ok: false, error: { code, message, exitCode, details?, suggestion? } }`, as does a failed release write. Codes: `SDK_SEED_IN_STATIC` (`details.leaks[]` → `publicSeed`), `SDK_EXPORT_INVALID` (`details.diagnostics[]`, `--strict` too), `SDK_DRIFT`, `SDK_BRANCH_TAKEN`, `SDK_BRANCH_LIVE`, `SDK_RELEASE_NAME_TAKEN`, `SDK_RELEASE_FILES_NOT_CARRIED`, `SDK_LIVE_BRANCH_MISMATCH` (`details.conflictsWith`), `SDK_IDENTITY_CONFLICT`, `SDK_KIND_CONFLICT`, `SDK_PRUNE_OUT_OF_SCOPE`, `SDK_IMPORT_REFUSED`, `SDK_SHARED_SCHEMA_CHANGE`, `SDK_CONSTRAINT_VIOLATION`, `SDK_CREDENTIAL_REJECTED` (`details`: `{ profile, credentialType, instance, workspaceId, signIn }`; ids null on a refused env refresh), `SDK_WORKSPACE_CHANGED` (deploy over objects edited in Xano since the last sync; `details.objects`; pull first or `--overwrite`), `SDK_USAGE` (`details.reason: "needs-confirmation"`: run its `Re-run as`), `SDK_ERROR`. Landing refusal `details.refused`: identityConflict, renamePending, kindConflict, uniqueViolation, tableTrigger, importInProgress, importRefused, pruneOutOfScope. `warnings[]` / `details.warnings` / `accepted[]` entries: `{ code, message, subject? }` (`subject`: the def's `{ kind, name }`). Backend documents add `selector` and `workspaceId`.
|
|
40
|
-
- A CLI command reports `could not reach <url>: fetch failed (<code>)` — blocked egress, not a bad credential; fix it before `
|
|
40
|
+
- A CLI command reports `could not reach <url>: fetch failed (<code>)` — blocked egress, not a bad credential; fix it before `npx @xano/sdk login`, which rotates a single-use refresh token.
|
|
41
41
|
|
|
42
42
|
### CLI exit codes
|
|
43
43
|
|
|
@@ -52,7 +52,7 @@ A failure document's `exitCode` matches.
|
|
|
52
52
|
| 4 | `deploy --require-microservices`: a microservice was not ready in time. The backend landed. | Check the microservice. |
|
|
53
53
|
| 5 | `test` / `deploy --test`: the suite ran and a test failed. A deploy is not retracted. | Fix the test or the code. |
|
|
54
54
|
| 6 | `test`, `deploy --test`: the suite could not be reached. | Check the backend; rerun. |
|
|
55
|
-
| 7 | `upgrade --check`: an upgrade is available. | `
|
|
55
|
+
| 7 | `upgrade --check`: an upgrade is available. | `npx @xano/sdk upgrade`. |
|
|
56
56
|
| 8 | A named backend could not be addressed (or a named release, profile, branch, test, module, lock entry, `--seed` guid or Xano Engine version is missing): gone, expired, unreachable, a stopped Xano Engine, or a busy import. | Retry, or redeploy. |
|
|
57
57
|
| 9 | A write whose outcome is unknown, Ctrl-C during a write included. | Read the target's state before retrying. |
|
|
58
58
|
| 130 | Ctrl-C outside a write or install. | — |
|
package/llms/fields.md
CHANGED
|
@@ -51,7 +51,7 @@ typed against the table's schema as a WRITE shape (a column without
|
|
|
51
51
|
(`seed: seedFile("./seed.json", import.meta.url)`; path resolves against the DECLARING
|
|
52
52
|
file), or a thunk (`seed: () => import("./seed.json")`, async ok, `.default` unwrapped).
|
|
53
53
|
Inline rows are TYPED against the schema at compile time; a `seedFile`/thunk seed is
|
|
54
|
-
not — `
|
|
54
|
+
not — `npx @xano/sdk export`/`deploy` validates it, naming the row index and column.
|
|
55
55
|
Timestamp seeds: epoch ms, `Date`, ISO 8601 date, or date-time with `Z`/offset; else THROWS.
|
|
56
56
|
Int seeds: whole, in int64 (past 2^53: a string).
|
|
57
57
|
⚠ Prefer `seedFile` for a file: a thunk's `import()` sits in
|
package/llms/kinds-agent-mcp.md
CHANGED
|
@@ -29,5 +29,5 @@
|
|
|
29
29
|
- `tools?`: same `ToolsetToolEntry[]` as `mcpServer` — bare `tool()` handles, or a `{ tool, enabled?, auth? }` wrapper when one needs `enabled`/`auth`. A tool reading `auth()` MUST use the wrapper naming the auth table — a bare handle runs it with no caller (see `mcpServer`'s `tools?`).
|
|
30
30
|
- `output?`: `{ schema: Record<string, input.*>, enabled? }` — structured-output schema. `schema` is a named-field record authored with the `input.*` catalog, exactly like a `defineFunction`/`query` `input:` map (the stored `structuredOutputsSchema` is the same wire shape as function inputs). e.g. `output: { schema: { priority: input.enum(["low","high"]), summary: input.text() } }`. When you pass the agent *handle* to `s.ai.agent.run({ agent })`, `.result` is typed straight from this schema — no `resultShape` witness needed (the shape is declared once). `resultShape` remains only to override that, or to type an agent referenced by bare name.
|
|
31
31
|
- **Run + read recipe (`s.ai.agent.run`):** bind the run to a var (`s.ai.agent.run({ agent, args, allowToolExecution: c.bool(true), as: "run" })`) — it produces a rich envelope, and the completion is at **`.result`**. Read one structured field with a dotted ref (`response: ref("run.result.priority")`) or the whole completion (`ref("run.result")`, typed from `output.schema`); persist it in a later step the same way (`s.set_var("summary", ref("run.result.summary"))`). `args` is a plain object of run inputs (`{ topic: inp("topic") }` — raw literals are fine, e.g. `{ max_steps: 3 }`) surfaced to the agent as `{{ $args.topic }}`. `.toolCalls` is the FINAL step's calls only (often `[]`); every call is a `.steps[].content[]` entry of `type: "tool-call"`. ⚠ An agent with tools needs `allowToolExecution: c.bool(true)` on the run: unset, its tools are OFF and it answers without them (warns `stack.agent-tools-off`).
|
|
32
|
-
- **Marketplace:** for chat history, use `@xano-sdk/chatbot`; for vector RAG, use `@xano-sdk/vector` (`tools: [vector.searchTool]`). Find add-ons with `
|
|
32
|
+
- **Marketplace:** for chat history, use `@xano-sdk/chatbot`; for vector RAG, use `@xano-sdk/vector` (`tools: [vector.searchTool]`). Find add-ons with `npx @xano/sdk marketplace search <q>`.
|
|
33
33
|
- Both kinds persist under the `toolset` payload key, so a same-name `agent` + `mcpServer` pair derives ONE guid and `export()` throws — give them distinct names.
|
package/llms/kinds-knowledge.md
CHANGED
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
# Knowledge def shape
|
|
2
2
|
|
|
3
|
-
> Read when the workspace defines a `knowledge()` item
|
|
3
|
+
> Read when the workspace defines a `knowledge()` item.
|
|
4
4
|
|
|
5
|
-
- `knowledge({ name, description?, type?, mode?, enabled?, body, refs?, guid?, tags? })` — markdown Xano's own AI reads before it acts — the workspace's builder agent, and outside agents reading the workspace through the Meta API or MCP. It does NOT reach an `agent()` run by `s.ai.agent.run`, whatever its `type` or `mode`: put what such an agent must know in its `llm.systemPrompt`. Takes `registerKnowledge`.
|
|
5
|
+
- `knowledge({ name, description?, type?, mode?, enabled?, body, refs?, guid?, tags? })` — markdown shared by every AI that builds the backend: Xano's own AI reads it before it acts — the workspace's builder agent, and outside agents reading the workspace through the Meta API or MCP — and a local coding agent reads the same `.md` files in the repo; deploy and `pull` keep the copies in sync. It does NOT reach an `agent()` run by `s.ai.agent.run`, whatever its `type` or `mode`: put what such an agent must know in its `llm.systemPrompt`. Takes `registerKnowledge`.
|
|
6
6
|
- `body` (REQUIRED): `knowledgeFile("./runbook.md", import.meta.url)` — a path to a real markdown FILE. There is no inline-string form. The path resolves relative to the MODULE THAT DECLARES the item, not the process working directory and not the workspace entry; `import.meta.url` is required and is what makes that true.
|
|
7
7
|
- `refs?`: `knowledgeDir("./runbook", import.meta.url)` — a directory whose WHOLE tree ships, recursively, paths preserved: UTF-8 text only (else refused; binary `.DS_Store` skipped), symlinks not followed. Keep the body OUT of it, or it ships as a reference file.
|
|
8
8
|
- `type?`: `"skill"` (default) | `"doc"` | `"agents.md"`. `skill` and `doc` differ in how they are filed, not in what an agent receives.
|
package/llms/kinds-realtime.md
CHANGED
|
@@ -35,7 +35,7 @@
|
|
|
35
35
|
- ⚠ FAIL-SOFT — a missing/disabled server or dead bus is swallowed engine-side, so a mis-targeted publish is SILENT with no result to check.
|
|
36
36
|
- `authTable`/`authId` are ASSERTED attribution on the frame — not a credential, nothing validates them.
|
|
37
37
|
- **Client recipe (derive, never hardcode):**
|
|
38
|
-
- `server.getUrl(baseUrl)` → `wss://<host>/ws/<canonical>` — accepts the `https://…` instance base URL and normalizes the scheme. `channel.getChannel({ room_id: 42 })` → `"rooms/42"`, the path that goes in a frame's `channel` field. Both throw rather than guess. A canonical is minted by `
|
|
38
|
+
- `server.getUrl(baseUrl)` → `wss://<host>/ws/<canonical>` — accepts the `https://…` instance base URL and normalizes the scheme. `channel.getChannel({ room_id: 42 })` → `"rooms/42"`, the path that goes in a frame's `channel` field. Both throw rather than guess. A canonical is minted by `npx @xano/sdk export <entry> --lock`.
|
|
39
39
|
- Auth is a bearer token passed as the websocket SUBPROTOCOL: `new WebSocket(url, token)`. No token = an anonymous client, admitted only where `anonymousClients: true`.
|
|
40
40
|
- Frames are JSON `{ action: "join"|"leave"|"broadcast"|"ack"|"ping"|"presence", channel, type?, payload?, options?, id? }`. `broadcast` REQUIRES `type`: a `realtimeMessage` of that channel, else refused `Unknown message type`. You must `join` before you may `broadcast`, and the server's context is ready only a moment after `open` — an immediate first frame is refused.
|
|
41
41
|
- `options` is `{ to?, client_id?, channel? }` — `to: { dbo_id, row_id }` makes the frame a direct message (needs `publish.direct`), `client_id` is the at-least-once cursor handle, and `options.channel` WINS over a top-level `channel`.
|
|
@@ -47,7 +47,7 @@
|
|
|
47
47
|
- **Tenant instances (isolated DB):** a tenant's realtime objects live in the TENANT's database, so BOTH halves of a client must name the tenant.
|
|
48
48
|
- Socket: `server.getUrl(base, { tenant })` → `/ws/<tenant>:<canonical>`. ⚠ A bare canonical on a tenant host resolves against the INSTANCE workspace instead.
|
|
49
49
|
- That colon form is PECULIAR TO THE SOCKET. Every other tenant URL gives the tenant its OWN segment — the HTTP half of the same client is `https://<host>/tenant/<tenant>/api:<canonical>/…`. NO request header is required for either.
|
|
50
|
-
- Because the shapes differ, `getUrl` TRANSLATES a tenant base URL instead of concatenating: pass the `https://<host>/tenant/<name>` that `
|
|
50
|
+
- Because the shapes differ, `getUrl` TRANSLATES a tenant base URL instead of concatenating: pass the `https://<host>/tenant/<name>` that `npx @xano/sdk status` prints (and that deploy injects as `window.XANO_HOST`) and the tenant is LIFTED into the socket form. So `getUrl(window.XANO_HOST)` needs no `{ tenant }`, and a CONFLICTING `{ tenant }` alongside it throws.
|
|
51
51
|
- ⚠ `getUrl`/`socketUrl` are NOT idempotent — a `baseUrl` that already carries a `/ws/<…>` path THROWS. Resolve ONCE from the http(s) base; never feed a result back in.
|
|
52
52
|
- Still pass `{ tenant }` explicitly for a tenant on its OWN DOMAIN — the hostname carries it for HTTP, but there is nothing in the URL for the socket to lift.
|
|
53
53
|
- ⚠ Tokens are tenant-scoped (audience `<tenant>:<license>`, not the bare license), so one minted through the instance workspace is REJECTED by a tenant's realtime server — authenticate and dial through the same tenant.
|
package/llms/lock.md
CHANGED
|
@@ -8,13 +8,13 @@ verb, name)`). Committed. A composed entry is keyed by that identity —
|
|
|
8
8
|
`query:<group>|<verb>|<name>`, `channel:<server>|<path>`, `message:<server>|<path>|<name>`
|
|
9
9
|
— its guid's seed; a legacy `query:<name>` is migrated by the next locked export.
|
|
10
10
|
|
|
11
|
-
- `
|
|
11
|
+
- `npx @xano/sdk lock rename <kind> <old> <new>` — `kind` is the SDK kind (`table`, `apiGroup`) or stored key (`dbo`).
|
|
12
12
|
Run it when `export` names it after a rename in code (it prints the command); the next export emits the original guid under the new name.
|
|
13
13
|
Reads the `index.ts` beside the lock (or `--entry`); refused while `<old>` is still exported. Composed names go in full; renaming a parent moves them.
|
|
14
|
-
- `
|
|
14
|
+
- `npx @xano/sdk lock prune <entry-file> [keys…] --yes` — drops orphaned entries. Finding orphans
|
|
15
15
|
RUNS the entry's module scope (env assertions included); `--identity-only --yes <key>…`
|
|
16
16
|
prunes named keys (`table:users`) with no evaluation and no orphan check.
|
|
17
|
-
- `
|
|
17
|
+
- `npx @xano/sdk lock import <live-bundle.json> [--yes]` — seed the lock from a `workspace export`
|
|
18
18
|
to take over an existing workspace (a compiled bundle is refused).
|
|
19
19
|
- Every lock subcommand accepts `--lock=<path>`; from outside the lock's directory pass it.
|
|
20
20
|
- Merge conflict: keep both sides; two keys on one guid → `lock rename` onto the kept
|
package/llms/object-kinds.md
CHANGED
|
@@ -12,7 +12,7 @@ Choose by who or what starts the work. Each rule names the kind that fits and th
|
|
|
12
12
|
- **Work on a timer** → `task` (cron or interval). **Work a request starts but does not wait for** → `s.function.run({ fn, runtime: { mode: "async-shared" } })`, which binds a job id, not the result (collect with `s.await`). **Work that follows a row change** → `tableTrigger`: it fires on every insert/update/delete of the table, whichever stack writes it, so the same side effect placed in one endpoint's stack misses every other write path.
|
|
13
13
|
- **The same steps before or after many objects** (an auth check, a rate limit, logging) → `middleware`, attached per host (`middleware: { pre, post }` on a query, function, task, tool or API group) or to every host of a kind with `workspaceConfig({ middleware: { query, function, task, tool } })` — not a function call repeated at the top of each stack.
|
|
14
14
|
- **Related rows on returned rows** → an `addon` attached to the read through its `addon: [{ addon, as, input }]` option (`db.query`/`get`/`add`/`edit`/`patch`), merged onto each row under `as` and typed in `InferResponse` — not a second read plus a loop that stitches rows together.
|
|
15
|
-
- **AI.** An LLM running inside the backend → `agent()`, started from a stack with `s.ai.agent.run`; it has no public endpoint. An external AI client (Claude, Cursor, any MCP client) calling the backend → `mcpServer()`. Standing instructions for Xano's own builder AI → `knowledge()
|
|
15
|
+
- **AI.** An LLM running inside the backend → `agent()`, started from a stack with `s.ai.agent.run`; it has no public endpoint. An external AI client (Claude, Cursor, any MCP client) calling the backend → `mcpServer()`. Standing instructions for Xano's own builder AI → `knowledge()` (a local coding agent reads the same files in the repo); an `agent()` run never reads it. The actions either one calls → `tool()`. What an MCP server serves besides tools (`prompt()`, `resource()`) and when each fits: `llms/kinds-agent-mcp.md`.
|
|
16
16
|
- **Pushing to connected clients** → `realtimeServer` → `realtimeChannel` → `realtimeMessage` (the handler for a frame a client sends — the realtime analogue of a query). A server-side push from any stack is `s.realtime.publish`; a client polling a `query` is the substitute this replaces.
|
|
17
17
|
- **Code the typed surface cannot express** → a lambda (`s.lambda`, `fl.lambda`) for a short JavaScript body, LAST, after native filters and expressions (`llms/lambda.md`); a `microservice` for a long-running container or another language; `s.api.request` for a service that already has an HTTP API.
|
|
18
18
|
- **Tests** → `tests` on a `query`/`defineFunction`/`middleware` for that one object's input → output; a `workflowTest` for a flow across objects (`s.function.call`, `s.api.call`, `s.task.call`) asserted with `s.expect.*`.
|
|
@@ -44,5 +44,5 @@ Choose by who or what starts the work. Each rule names the kind that fits and th
|
|
|
44
44
|
- channel: `realtimeChannel` → `Xano.registerRealtimeChannels` → payload `channel` — A realtime channel: a joinable path on a realtime server (`rooms/{room_id}`) with typed path params, join/publish policy, a client-visible conversation transcript, and delivery semantics. Owns message handlers. Returns a handle with `getChannel(params)` for the path a client joins.
|
|
45
45
|
- message: `realtimeMessage` → `Xano.registerRealtimeMessages` → payload `message` — A realtime message handler: a named message type on a channel with its own typed payload and stack — the realtime analogue of a query. Pass the `realtimeChannel()` handle as `channel` and the owning server comes with it.
|
|
46
46
|
- microservice: `microservice` → `Xano.registerMicroservices` → payload `microservice` — A container workload deployed alongside the workspace, called from a stack with `s.microservice.request`. Def shapes (`builtin` containers vs a `helm` chart) and the SECRET-handling rules its config carries: `llms/statements-calls.md`.
|
|
47
|
-
- knowledge: `knowledge` → `Xano.registerKnowledge` → payload `knowledge` — Markdown Xano's own AI (the builder agent,
|
|
47
|
+
- knowledge: `knowledge` → `Xano.registerKnowledge` → payload `knowledge` — Markdown shared by every AI that builds the backend — Xano's own AI (the builder agent, Meta API / MCP readers) and a local coding agent reading the same files — never an `agent()` run: an `agents.md` of standing instructions, a `skill`, or a `doc`. The body is a real markdown FILE via `knowledgeFile("./x.md", import.meta.url)`, and `mode` decides how much of it reaches the agent.
|
|
48
48
|
- workspace: `workspaceConfig` → `Xano.registerWorkspace` → payload `workspace` — Workspace-level configuration such as default middleware chains and request-history defaults per host kind.
|
package/llms/statements-calls.md
CHANGED
|
@@ -5,7 +5,7 @@
|
|
|
5
5
|
Auth & calls:
|
|
6
6
|
|
|
7
7
|
- `s.security.create_auth_token({ table, id, extras?, expiration?, as? })` — `extras` defaults to `{}`, `expiration` (seconds, a `Value`: `c.int(3600)`) to 86400 (`c.int(0)` = never).
|
|
8
|
-
- **Marketplace first:** `@xano-sdk/auth` registers a complete auth surface — signup/login/me endpoints plus their `user`/`account`/`event_log` tables — via `registerAuth(ws, { canonical: "authn" })`. Authentication only, not authorization. Inspect with `
|
|
8
|
+
- **Marketplace first:** `@xano-sdk/auth` registers a complete auth surface — signup/login/me endpoints plus their `user`/`account`/`event_log` tables — via `registerAuth(ws, { canonical: "authn" })`. Authentication only, not authorization. Inspect with `npx @xano/sdk marketplace details @xano-sdk/auth --prompt`.
|
|
9
9
|
- **The auth loop end to end** — what that module implements; author it directly for a custom flow. An auth TABLE (`table({ auth: true })`) backs identity; a PUBLIC login query verifies and mints a token; every protected query names that table as `auth:` and reads the caller with `auth(...)`.
|
|
10
10
|
- Signup: `s.db.add({ table: users, row: { email: inp("email"), password: inp("password") } })` — the `f.password()` column hashes on write; take the submission as `input.text()` on signup AND login (see Gotchas on double-hashing).
|
|
11
11
|
- Login: `s.db.get({ table: users, fieldName: "email", fieldValue: inp("email"), output: ["id", "password"], as: "u" })` — the `output` naming `password` is REQUIRED (the column is `access: "internal"` and absent from the row otherwise) → `s.precondition({ expr: expr(ref("u", { safe: true }), "!=", c.null()), error: c.text("No such user."), error_type: "notfound" })` → `s.security.check_password({ text_password: inp("password"), hash_password: ref("u.password"), as: "ok" })` → precondition on `ok` → `s.security.create_auth_token({ table: users, id: ref("u.id"), as: "token" })` → `response: { token: ref("token") }`.
|
|
@@ -60,10 +60,10 @@ Runtime behavior (what the `as:` output holds, and misses):
|
|
|
60
60
|
- Workspace-level defaults are the terminal tier: `workspaceConfig({ history: { query, function, task, tool, trigger, middleware } })` emits the flat `{objType}_enabled`/`{objType}_limit` map (no inherit flag) — setting it is wholesale (unlisted types fall back to their engine default), so declare every default you want to keep; omit the field to leave existing workspace history untouched.
|
|
61
61
|
|
|
62
62
|
- **Workspace environment variables** set a tenant's env vars through the workspace object: `workspaceConfig({ env: { STRIPE_KEY: "", APP_BASE_URL: "" } })`, passed to `registerWorkspace()` — unattached, it declares nothing. Author them as a name→value MAP, declaring each NAME with an EMPTY value. Read a var back with `env("NAME")` (→ `$env.NAME`), which compiles to tag "setting" with the plain name.
|
|
63
|
-
- Values are SECRETS and do NOT belong here: they live in `xano/.env`, which is gitignored and survives a `
|
|
63
|
+
- Values are SECRETS and do NOT belong here: they live in `xano/.env`, which is gitignored and survives a `npx @xano/sdk pull`, and every command that compiles a bundle reads it with no flag. Fill it by hand from `xano/.env.example`, or run `npx @xano/sdk env pull`. CI passes `--backend-env-file <path>` or `--env-var KEY=VALUE` instead. A compiled bundle carries the values in cleartext — don't commit one.
|
|
64
64
|
- What a deploy sends is the RESOLVED map (the declared names, then ONE file — `xano/.env`, or `--backend-env-file <path>` which REPLACES it, never both — then `--env-var`), not the literal object written here. `deploy` REPLACES the tenant's env with it, so a declared name with no value anywhere REFUSES the deploy rather than clearing the live value — fill the name in rather than putting the value back in source, and reach for `--allow-empty-env=NAME` only when clearing is what you mean.
|
|
65
65
|
|
|
66
66
|
- **Workspace documentation** gates the workspace's hosted docs: `workspaceConfig({ documentation: { require_token: true } })`. `require_token: true` IS the declaration that a token exists; the value lives in `xano/.secrets.json`, keyed by the object it gates rather than by a name, and a literal `token` FAILS the export. It is NOT a backend env var — `env()` cannot read it. Other members are carried verbatim.
|
|
67
67
|
- ⚠ OMIT the block and NO `documentation` key is emitted, leaving the target's live block as it is; the legacy `realtime` block follows the same rule. An `apiGroup`'s `documentation` follows the OPPOSITE rule — see its def shape.
|
|
68
|
-
- A declared gate with no token emits no block at all and REFUSES a `deploy`; `--allow-empty-doc-token=<scope>` clears that gate deliberately (scope = `workspace`, or an API group's NAME). `
|
|
68
|
+
- A declared gate with no token emits no block at all and REFUSES a `deploy`; `--allow-empty-doc-token=<scope>` clears that gate deliberately (scope = `workspace`, or an API group's NAME). `npx @xano/sdk pull` writes `xano/.secrets.json`, and `--no-secrets` writes none.
|
|
69
69
|
- A merge (`deploy --to`) is ADD-ONLY, matched BY NAME — it creates names the target lacks but does NOT update or remove ones it has, so the target's value wins. Two gaps: a release carries no env values, so a NEW name reads null after `promote`/`tenant deploy` until `env set` (both name it first) — and a `--replace` deploy rebuilds it so every env var the target holds that the config does not declare is DROPPED (named, and confirmed, before it runs). Omit `env` entirely to leave existing env untouched. The separate `settings` field is a plain object.
|
package/llms/tests.md
CHANGED
|
@@ -49,11 +49,11 @@ The run is isolated in ways that make a correct test fail for reasons the failur
|
|
|
49
49
|
|
|
50
50
|
### Running them
|
|
51
51
|
|
|
52
|
-
`
|
|
52
|
+
`npx @xano/sdk test run-all` runs the unit tests AND the `workflowTest()` objects an environment carries. It takes no entry file and compiles nothing: it runs what is DEPLOYED, so deploy before testing.
|
|
53
53
|
|
|
54
54
|
- `--on <backend>` picks the backend — `--on ephemeral:<name>`, `--on local`, `--on tenant:<name>`, `--on workspace`; omitted, the one this project last deployed to (grammar: **Backends** in `llms.txt`). ⚠ `workspace` runs against the REAL database: safe only while every test keeps `datasource: ""`, since a stored non-empty datasource is CLONED before the run.
|
|
55
|
-
- `
|
|
55
|
+
- `npx @xano/sdk test list` shows what is there without running it; `test run "<name>"` runs one; an ambiguous name prints qualified forms (`function:math/happy path`, `workflow:<name>`) `run` accepts.
|
|
56
56
|
- `--kind unit|workflow` narrows to one family. `--concurrency <n>` defaults to 1: tests share the environment database.
|
|
57
57
|
- A failing suite exits 5; exit 6 when the suite could not be reached — retry it; a backend that can't be looked up exits 8 (see errors). Having no tests is success.
|
|
58
58
|
- For CI: the exit code says THAT something failed, the JSON says WHICH. Progress goes to stderr; stdout carries one JSON document when not a terminal, or with `--json`. `run-all` and `run`: `{ kind, env, name, display, total, passed, failed, tests: [{ kind, name, qualified, object?, status: "pass"|"fail", message?, expectations?: [{ index, status, message? }], timing? }] }` (`message`: the first failure; `expectations`: a unit test's every expectation in order, `index` from 0; `env`: an ephemeral's or tenant's name; `name`: the backend's own, a Xano Engine's too; null if none), same keys on an empty suite. `list` is `{ kind, env, name, display, total, tests }`; `deploy --test` nests the run under `testRun`.
|
|
59
|
-
- `
|
|
59
|
+
- `npx @xano/sdk deploy ./index.ts --test` deploys and then runs the suite against what it just shipped. A failure exits 5 WITHOUT retracting the deploy — the environment is live either way.
|
package/llms/toolchain.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# Toolchain modules
|
|
2
2
|
|
|
3
|
-
> Read when `package.json` has a `"xanosdk"` block or you run `
|
|
3
|
+
> Read when `package.json` has a `"xanosdk"` block or you run `npx @xano/sdk marketplace`.
|
|
4
4
|
|
|
5
5
|
**Toolchain modules** extend the CLI, not the workspace — nothing to register in
|
|
6
6
|
`xano/index.ts`. An installed one runs on `export` and `deploy` (after the compile,
|
|
@@ -25,4 +25,4 @@ the request inputs under the manifest's keys and its config, it returns `{ impor
|
|
|
25
25
|
imports as bare package names (`@xano/sdk*`, relative and `node:` are refused). A module that
|
|
26
26
|
fails to load or throws leaves its previous block as it was, with a warning naming it, and the
|
|
27
27
|
core sections still refresh; under `routes --emit --strict` it is fatal. `@xano-sdk/zod`
|
|
28
|
-
(`
|
|
28
|
+
(`npx @xano/sdk marketplace install zod`) is one: it adds `ROUTE_SCHEMAS` and its siblings.
|