@starvale-sdk/sts
v1.1.12
Published
STS CLI - A sleek, fast, and modern custom wrapper for npm
Maintainers
Readme
STS CLI ⚡
sts is a modern, lightweight, and super-fast CLI wrapper for npm. It lets you run common package manager tasks with short commands (like yarn or pnpm), and automatically manages standard command shortcuts, routing everything seamlessly to npm under the hood.
Key Features
- ⚡ Modern Command Aliasing: Supports Yarn/PNPM style commands like
sts add <package>andsts remove <package>(mapped tonpm install/npm uninstall). - 📦 Auto Script Detection: Running
sts <script>will check your localpackage.jsonfor scripts (e.g.,dev,build). If found, it automatically executes it asnpm run <script>without needing to typerun. - ✨ Premium Visual Banner: Shows exactly what
npmcommand is running with styled, zero-dependency ANSI console headers. - 🚀 Zero Dependencies: Written in pure Node.js with no external npm dependencies, making it instantly executable and highly performant.
License & Access Verification 🔐
To prevent unauthorized usage, the sts runner requires your project's package.json to contain a valid token and licenseKey.
Before running any script or installing dependencies, the CLI will automatically perform a verification check against https://studio.althar.dev.
Setup
Add the "token" and "licenseKey" fields to the root of your project's package.json:
{
"name": "your-project",
"version": "1.0.0",
"token": "YOUR_ACCESS_TOKEN",
"licenseKey": "YOUR_LICENSE_KEY"
}Note: Informational commands (like sts -v, sts --help, sts help) will bypass this check automatically.
Installation
To install and use sts globally on your system:
1. Locally Linking (Development)
In the directory of this package (d:\Althar\SDK\sts), run:
npm linkThis creates a symlink from your global bin to this package, allowing you to use sts immediately.
2. Global Installation
Alternatively, you can install it globally via:
npm install -g .3. Publishing to NPM 🚀
Because the name sts is already taken on the public NPM registry, you should publish it under a unique name or as a scoped package:
- Rename the package in
package.json's"name"field:- To publish as a scoped package (e.g.
@your-username/sts):
(Note: Even with a scoped name, npm will still register the command as"name": "@your-username/sts"stsbecause of the"bin": { "sts": "./bin/sts.js" }config!) - Or rename it to a unique unscoped name:
"name": "sts-cli-wrapper"
- To publish as a scoped package (e.g.
- Login to NPM in your terminal:
npm login - Publish the package:
- If using a scoped package (e.g.
@your-username/sts), run:npm publish --access public - If using an unscoped package, run:
npm publish
npm install -g <your-package-name>and use it via thestscommand! - If using a scoped package (e.g.
Usage
Here are some comparisons of how sts simplifies your commands:
| Command | Action | Equivalent NPM Command |
|---------|--------|------------------------|
| sts install | Install dependencies | npm install |
| sts start | Start project | npm start |
| sts dev | Run development script | npm run dev |
| sts build | Run build script | npm run build |
| sts add <name> | Add a dependency | npm install <name> |
| sts remove <name> | Remove a dependency | npm uninstall <name> |
Enjoy a faster and cleaner terminal workflow! ⚡
