@abzedsync/engine
v1.3.0
Published
AbzedSync local agent - progress publishing, shared doc sync, and GitLab send CLI (`abzedsync`)
Maintainers
Readme
@abzedsync/engine
AbzedSync local agent - a cross-platform project sync engine that watches local code changes, publishes manager-friendly work items to the AbzedSync control plane, keeps shared docs in sync, and sends eligible items to GitLab when asked.
Install
npm install -g @abzedsync/engineRequires Node.js 18 or newer. Supported platforms: Linux, macOS, Windows.
Quick start
# 1. Authenticate against the AbzedSync control plane
abzedsync login
# 2. Initialize a project in the current directory
cd /path/to/your/repo
abzedsync init
# 3. Start the watcher
abzedsync start
# 4. Publish current work for visibility only
abzedsync progress --push
# 5. Send eligible work to GitLab when you want it published there
abzedsync gitlab --pushCommands
| Command | Purpose |
| --- | --- |
| abzedsync login | Sign in to the AbzedSync control plane |
| abzedsync init | Register the current repo as a project side |
| abzedsync start | Start the long-running watcher |
| abzedsync stop | Stop the watcher for this project |
| abzedsync status | Show current agent status |
| abzedsync sync --push | Push local docs/project-apis.md into the shared store |
| abzedsync sync --pull | Pull the latest shared docs/project-apis.md into this repo |
| abzedsync sync --merge | Merge frontend/backend shared doc snapshots into a fresh canonical copy |
| abzedsync progress --push | Publish engine-detected changes to AbzedSync (publish/view-only) |
| abzedsync progress --stats | Show progress counts for the project |
| abzedsync gitlab --push | Send every eligible unsent active-queue item directly to GitLab |
| abzedsync gitlab --push --ids <uuids> | Send only the listed items |
| abzedsync accept | Resolve a sync conflict by accepting a side |
| abzedsync logs | Tail the engine log output |
Runtime state
The agent stores session and project state under the user's home directory:
~/.abzedsync/
config.json
session.json
pids/
logs/
shared-docs/Per-project state lives in the repo where you ran abzedsync init:
<project>/
.abzedsync.json
docs/
project-apis.md
project-sync/Sync behavior
abzedsync progress --pushis publish/view-only. It makes detected work visible in AbzedSync and does not talk to GitLab.abzedsync gitlab --pushsends eligible unsent items directly to GitLab and archives them out of the active queue on success.abzedsync sync --mergereads the latest frontend/backend shared doc snapshots, merges matching top-level sections, and preserves both sides when their content still differs.
GitLab connection
GitLab linking happens in the AbzedSync app under Settings -> Profile. The CLI checks the live backend account state before GitLab send commands.
License
UNLICENSED - internal distribution.
