* align docs and contract

* clean

* rename from deskctl-cli to deskctl

* runtime
This commit is contained in:
Hari 2026-03-26 08:44:10 -04:00 committed by Harivansh Rathi
parent 88f9ff85a3
commit eac3a61ceb
18 changed files with 41 additions and 47 deletions

View file

@ -1,11 +1,11 @@
# deskctl-cli
# deskctl
`deskctl-cli` installs the `deskctl` command for Linux X11 systems.
`deskctl` installs the command for Linux X11 systems.
## Install
```bash
npm install -g deskctl-cli
npm install -g deskctl
```
After install, run:
@ -17,7 +17,7 @@ deskctl --help
One-shot usage is also supported:
```bash
npx deskctl-cli --help
npx deskctl --help
```
## Runtime Support
@ -26,7 +26,7 @@ npx deskctl-cli --help
- X11 session
- currently packaged release asset: `linux-x64`
`deskctl-cli` downloads the matching GitHub Release binary during install.
`deskctl` downloads the matching GitHub Release binary during install.
Unsupported targets fail during install with a clear runtime support error instead of installing a broken command.
If you want the Rust source-install path instead, use:

View file

@ -17,7 +17,7 @@ function main() {
`Expected: ${binaryPath}`,
`Package version: ${pkg.version}`,
`Release tag: ${releaseTag(pkg)}`,
"Try reinstalling deskctl-cli or check that your target is supported."
"Try reinstalling deskctl or check that your target is supported."
].join("\n")
);
process.exit(1);

View file

@ -1,7 +1,7 @@
{
"name": "deskctl-cli",
"name": "deskctl",
"version": "0.1.6",
"description": "Installable deskctl CLI package for Linux X11 agents",
"description": "Installable deskctl package for Linux X11 agents",
"license": "MIT",
"homepage": "https://github.com/harivansh-afk/deskctl",
"repository": {

View file

@ -44,6 +44,6 @@ async function main() {
}
main().catch((error) => {
console.error(`deskctl-cli install failed: ${error.message}`);
console.error(`deskctl install failed: ${error.message}`);
process.exit(1);
});

View file

@ -26,7 +26,7 @@ function supportedTarget(platform = process.platform, arch = process.arch) {
}
throw new Error(
`deskctl-cli currently supports linux-x64 only. Received ${platform}-${arch}.`
`deskctl currently supports linux-x64 only. Received ${platform}-${arch}.`
);
}

View file

@ -26,13 +26,13 @@ function main() {
}
if (pkg.bin?.deskctl !== "bin/deskctl.js") {
throw new Error("deskctl-cli must expose the deskctl bin entrypoint.");
throw new Error("deskctl must expose the deskctl bin entrypoint.");
}
const target = supportedTarget("linux", "x64");
const targetPath = vendorBinaryPath(target);
const vendorDir = path.dirname(targetPath);
if (!vendorDir.endsWith(path.join("deskctl-cli", "vendor"))) {
if (!vendorDir.endsWith(path.join("deskctl", "vendor"))) {
throw new Error("Vendor binary directory resolved unexpectedly.");
}
}