← Back To Games

CLI Tool Installation Guide

CCLS Games CLI Tool v2.1.5

Hello and welcome to the CCLS Games CLI Tool. This PowerShell script is meant to be used as a fairly simple command line tool for downloading and managing games from our website.

↓ Download CLI Tool 📦 Archived Versions

Prerequisites:

1

Create a Dedicated Folder

First, create a new folder anywhere on your computer where you'd like to store the script.

Tip: Consider creating this folder in an easy-to-access location like your Documents folder or Desktop.

Once you've created the folder, place the CLI.ps1 PowerShell script inside it.

2

Configure PowerShell Security Settings

PowerShell has security features that prevent unauthorized scripts from running. We need to adjust these settings to run the script:

  1. Click on the Start menu
  2. Type "PowerShell"
  3. Right-click on "Windows PowerShell" and select "Run as administrator"
  4. When PowerShell opens, enter the following command:
Set-ExecutionPolicy RemoteSigned -Scope CurrentUser

When prompted to confirm the change, type A (for "Yes to All") and press Enter.

Note: This setting allows you to run local scripts while still requiring downloaded scripts to be signed by a trusted publisher. This is safer than completely disabling security protections.
3

First Run: Handle Security Warning and Login

Now you're ready to run the script for the first time. This involves handling a Windows security prompt and logging into your account:

Windows Security Warning

  1. Navigate to the folder where you placed CLI.ps1
  2. Right-click on the CLI.ps1 file
  3. Select "Run with PowerShell" from the context menu
  4. Windows will show a security warning dialog
Important Security Tip: In the security dialog, you'll see a checkbox that says "Always ask before opening this file". Uncheck this box before clicking "Open" - otherwise Windows will show this warning every time you run the script, which can be annoying.

Login or Create Account

After the script starts, you'll be prompted to log in:

Save Login Info: After successful login, the script will ask if you want to remember your login information for next time. Choose "Y" if you want to automatically log in on future runs (recommended for convenience).
4

Check System Requirements

Once logged in, you should check what components you need to install for full functionality:

CCLS>check
Important: The CLI Tool will check your system and tell you exactly what components you need to install. All components listed below are now required for script operation:
  • 7-Zip - REQUIRED for extracting game files after downloading. Games cannot be installed without this component.
  • Python - REQUIRED for download functionality. Provides a much faster download experience (up to 10x faster).
  • Python requests library - REQUIRED if Python is installed. This library is essential for the download system to function properly.
5

Install Required Components

Based on the check results, you can install the required components directly from the CLI Tool:

Installing 7-Zip (Required)

7-Zip is required to extract downloaded game files. Without it, games cannot be installed properly.

CCLS>install 7zip

Installing Python (Required)

Python is required for download functionality. Install it with:

CCLS>install python
Tip: When installing Python, make sure to check "Add Python to PATH" in the installer to enable all CLI Tool features.
Important: Once Python installation is finished and you have closed the installer, CLI Tool needs to be restarted for Python to be recognized by CLI Tool properly.

Installing Python Requests Library (Required)

The requests library is needed for the download system to function. Install it with:

CCLS>install requests
Tip: If the install requests command returns an error about Python not being found, make sure you restarted CLI Tool after Python installation.
Success: After installing these components, your CLI Tool will be fully functional with the best performance. The tool will guide you through each installation process.
6

Run the Setup Command

Before downloading any games, you must run the setup command to configure your download directories:

CCLS>setup

The setup process will ask you to specify two important directories:

  1. Games installation directory - This is where your downloaded games will be installed
  2. Temporary download directory - This is where game files will be temporarily stored during download before being extracted
Important: The setup step is mandatory. You cannot download games until you've completed this configuration.
Tip: Choose directories with plenty of free space, especially for the games installation directory. Some games can be quite large.
7

Using the CLI Tool

Once you have installed the necessary components and completed setup, you can start using the CLI Tool. The tool has an extensive help system:

Essential Commands

Quick Start: Type search library to see all available games, then use get [game_id] to download one!

Basic Workflow

Example workflow:
  1. Type search library to see all available games
  2. Find a game you want and note its ID (e.g., cg0025)
  3. Type get cg0025 to download and install it
  4. Use browse to manage your installed games
8

Troubleshooting

If you encounter any issues:

Common Issue #1: If you get an error about missing dependencies when trying to download games, make sure you've run the install commands for all required components (7zip, python, requests).
Common Issue #2: If PowerShell shows an error about execution policy, make sure you ran the Set-ExecutionPolicy command correctly in Step 2.
Common Issue #3: If you get an error saying "you must run the 'setup' command before downloading", make sure you've completed the setup process in Step 6.
Common Issue #4: If Windows keeps showing the security warning, make sure you unchecked "Always ask before opening this file" when you first ran the script.
Common Issue #5: If you see messages about the CLI Tool being in a "broken state" or missing critical dependencies, run the check command to see what components need to be installed.
Remember: The check command is your best friend for troubleshooting. It will tell you exactly what components are missing or need to be updated.