KyoSync CLI

Install Global

npm install -g kyo-sync-cli

If you are developing locally:

cd /Users/kyo/test3/ks-cli
npm install
npm link

New Project

ksync new my-game

ksync new now starts the daemon automatically by default. Use --serve false to scaffold only.

Resume Last Serve

ksync resumeserve

resumeserve starts serving the last project config used by ksync serve.

Existing Project

Auto-detect common folders:

cd existing-project
ksync adopt --project . --force true
ksync serve --config ./kysync.config.json

Or explicit source/destination:

cd existing-project
ksync adopt --project . --source ./src --destination ReplicatedStorage --force true
ksync serve --config ./kysync.config.json

Then in Roblox Studio:

1. Open KyoSync plugin
2. Host localhost
3. Port 8080
4. Click Connect
5. Confirm sync direction in popup

kysync.config.json

codebase mappings define local folders to push and preview.

Example:

{
  "port": 8080,
  "syncDir": "./sync",
  "sourcemap": "./sourcemap.json",
  "deleteOrphansOnConnect": true,
  "bootstrapSourcemapOnStart": true,
  "propagateDeletes": false,
  "previewLimit": 300,
  "codebase": [
    { "source": "./sync", "destination": "", "destructive": false },
    { "source": "./src", "destination": "ReplicatedStorage", "destructive": false }
  ]
}

VS Code Setup

1. Install extension: JohnnyMorganz.luau-lsp
2. Open project folder /Users/kyo/test3
3. Add these settings in VS Code settings.json:

{
  "luau-lsp.plugin.enabled": true,
  "luau-lsp.sourcemap.enabled": true,
  "luau-lsp.sourcemap.autogenerate": false,
  "luau-lsp.sourcemap.sourcemapFile": "sourcemap.json",
  "luau-lsp.sourcemap.includeNonScripts": true
}

Commands

ksync new <project-name> [--dir .] [--port 8080] [--force true] [--with-src true] [--serve true]
ksync adopt [--project .] [--port 8080] [--force true] [--source ./src] [--destination ReplicatedStorage]
ksync init [--config ./kysync.config.json] [--force true]
ksync serve [--config ./kysync.config.json] [--port 8080] [--dir ./sync] [--sourcemap ./sourcemap.json]
ksync resumeserve [--port 8080]
ksync build [--config ./kysync.config.json] [--port 8080] [--source ./sync] [--from-sourcemap ./sourcemap.json]
ksync push --config ./kysync.config.json --source <path> --destination <Service/Folder> [--destructive true] [--port 8080]
ksync plugin-build [--project ./kyo-sync.plugin.project.json] [--output ./KyoSyncPluginPlace.rbxlx]

Publish To npm

cd /Users/kyo/test3/ks-cli
npm login
npm run check
npm publish --access public