samcli

An interactive, zero-dependency, ultra-lightweight Node.js command-line utility to query the Samsung CheckFirm API.

Features

• Interactive Mode: Runs a step-by-step wizard to prompt you for the Model, CSC/Region, and API Key (with smart defaults).
• Direct CLI Mode: Pass parameters directly (node samcli.js <model> <csc> [api_key]) for instant results.
• Zero Dependencies: Pure Node.js! No need for npm install or massive node_modules folders.
• Rich UI/UX: Includes an ASCII art header, animated loader spinner, and colored box-drawing layout output.
• Rate-Limited by default: Free tier allows up to 2 queries per day per IP. You can bypass the limit by providing a valid API key.

Special Acknowledgments

🌟 Special Thanks to killshot!

This tool and its UI improvements were created with key contributions and inspiration from killshot. Thank you for helping shape the user experience!

Installation

Ensure you have Node.js installed (v12.0.0 or higher).

Method 1: Global CLI Install (Recommended)

You can install this tool globally directly from the NPM Registry:

# Using npm
npm install -g @deloskiyt/samcli

# Using yarn
yarn global add @deloskiyt/samcli

Or install it directly from GitHub:

# Using npm
npm install -g ktopytal/samcli

# Using yarn
yarn global add ktopytal/samcli

Once installed, you can run the tool from anywhere in your terminal using the samcli command!

Method 2: Local Run (No Install)

1. Clone this repository:

   git clone https://github.com/ktopytal/samcli.git
   cd samcli

2. Run the script directly:

   node samcli.js

Usage Examples

1. Interactive Mode (Wizard)

Simply execute the command without arguments:

# If installed globally
samcli

# If running locally
node samcli.js

Follow the prompts in your terminal:

• Enter Model (e.g. SM-S928B)
• Enter Region/CSC (e.g. EUX)
• Enter API Key (optional, press Enter to use the free tier limit of 2 requests per day)

2. Direct CLI Arguments

Check a device instantly:

# If installed globally
samcli SM-S928B EUX

# If running locally
node samcli.js SM-S928B EUX

Query with a private API key to bypass limits:

# If installed globally
samcli SM-S928B EUX your_api_key_here

# If running locally
node samcli.js SM-S928B EUX your_api_key_here

License

This project is licensed under the MIT License.