View RawView Code

User Guide

This comprehensive guide covers how to use the CCLS Games CLI Tool effectively, from basic operations to advanced features.

Table of Contents

  1. Getting Started
  2. Basic Workflow
  3. Game Discovery
  4. Downloading Games
  5. Managing Installed Games
  6. Interactive Browse Mode
  7. Library Cache System
  8. Logging and Session Management
  9. Startup Messages
  10. Developer Mode
  11. Advanced Features

Getting Started

First Launch

After installation, when you first run the CLI Tool:
  1. Login Process: Enter your CCLS Games credentials
  2. Setup Configuration: Run setup to configure directories
  3. Dependency Check: Run check to verify all components are installed
  4. Ready to Use: Start exploring games with search library

Understanding the Interface

The CLI Tool uses a command-line interface with the prompt: 
CCLS>
Commands are entered after this prompt. The tool provides extensive help:

Basic Workflow

Typical Session Flow

  1. Start the CLI Tool
Right-click CLI.ps1 → Run with PowerShell
  1. Browse Available Games
CCLS>search library
  1. Download a Game
CCLS>get cg0025
  1. Manage Installed Games
CCLS>browse
  1. Exit
CCLS>exit

Key Concepts

Game IDs

File Organization

Game Discovery

Browsing the Library

CCLS>search library
This displays all available games and bundles in a formatted list showing:

Searching by Name

CCLS>search game [search term]
Examples: 
CCLS>search game tekken
CCLS>search game assassin
CCLS>search game call of duty
This provides:

Getting Game Information

CCLS>search [game_id]
Example: 
CCLS>search cg0025
Displays detailed information:

Downloading Games

Basic Download

CCLS>get [game_id]
Example: 
CCLS>get cg0025

Download by Name

CCLS>get game [game_name]
Example: 
CCLS>get game tekken 8

Skip Confirmation

CCLS>get [game_id] -y
CCLS>get game [game_name] -y

Download Process

  1. Validation: Checks game ID and availability
  2. Confirmation: Shows game info and asks for confirmation
  3. Download: High-speed download with progress tracking
  4. Extraction: Automatic extraction using 7-Zip
  5. Metadata: Saves game information for future management

Download Features

Direct Download from Search

When using search game [term], you can download directly: 
CCLS>search game tekken
[Results shown]
Selection: get 2

Managing Installed Games

List All Games

CCLS>list all           # Basic list
CCLS>list all -d        # Detailed view with versions and sizes

Get Game Information

CCLS>list [folder_name]              # Basic info
CCLS>list [folder_name] -d           # Detailed info
CCLS>list [folder_name] -tree        # File tree view
CCLS>list [folder_name] -tree -d     # Detailed info + file tree

Alternative Identification Methods

CCLS>list [game_id]                  # By game ID
CCLS>list game [game_name]           # By game name
CCLS>list gamedir [folder_name]      # By folder name (explicit)

Delete Games

CCLS>del [folder_name]               # With confirmation
CCLS>del [folder_name] -y            # Skip confirmation
CCLS>del [game_id]                   # By game ID
CCLS>del game [game_name]            # By game name

Interactive Browse Mode

Starting Browse Mode

CCLS>browse

Browse Interface

The browse mode displays:

Browse Commands

Browse Features

Library Cache System

What is the Cache?

The CLI Tool maintains a local cache (lib.json) that stores:

Cache Benefits

Cache Management

CCLS>sys cache status      # View cache information
CCLS>sys cache refresh     # Manually rebuild cache

When Cache Updates

Logging and Session Management

Session Logs

Every CLI Tool session creates a log file in the logs/ folder:

Log Management

CCLS>log list                        # Browse all logs
CCLS>log list -5                     # Show 5 newest logs
CCLS>log view [filename]             # View log contents
CCLS>log del [filename]              # Delete a log
CCLS>log open [filename]             # Open with default editor

Log Browser

The log browser provides:

Startup Messages

What are Startup Messages?

Customizable welcome screens that appear after login, featuring:

Managing Startup Messages

CCLS>sys start-message list                 # Available templates
CCLS>sys start-message get [template]       # Download template
CCLS>sys start-message enable [template]    # Enable template
CCLS>sys start-message get,enable [template] # Download and enable
CCLS>sys start-message try [template]       # Preview template
CCLS>sys start-message view                 # View current message
CCLS>sys start-message default              # Disable custom messages

Template Types

Developer Mode

What is Developer Mode?

A special mode for testing and development that:

Activating Developer Mode

  1. During Login: Press Ctrl+Q and type "devmode"
  2. From CLI: devmode command toggles the mode

Developer Mode Features

Exiting Developer Mode

CCLS>devmode
This toggles back to normal mode and clears stored credentials.

Advanced Features

Version Management

CCLS>version                 # Check current version
CCLS>update                  # Update CLI Tool
CCLS>changelog [version]     # View version changes
CCLS>changelog latest        # Latest version changes

System Utilities

CCLS>check                   # System requirements check
CCLS>setup                   # Reconfigure directories
CCLS>install [utility]       # Install dependencies
CCLS>clear                   # Clear console

Credential Management

CCLS>logout                  # Log out and re-login
CCLS>forget                  # Remove stored credentials

Performance Optimization

Safety Features

Tips and Best Practices

Efficient Workflow

  1. Use browse for regular game management
  2. Use search game [name] when you know what you want
  3. Enable login saving for convenience
  4. Regular cache refresh for large libraries

Storage Management

Performance Tips

Security Considerations

Next Steps