PikaCLI

Official documentation

Everything
PikaCLI.

Install PikaCLI, learn its organized command namespaces, and explore every built-in developer, system, network, file, and project tool.

Get started View source
PikaCLI 
PS> pika system doctor

✓ Python environment
✓ Internet connection
✓ Release service
✓ PikaCLI is up to date

PS> pika --help
system    System tools
network   Network tools
security  Security tools
file      File tools
time      Time tools

Get started

From download to useful in seconds.

PikaCLI is a Python 3.11+ terminal toolkit with a polished Rich interface. Download the latest Windows x64 release, or run it from source on Windows, Linux, and macOS.

Download latest All releases

Run from source

git clone https://gitlab.com/pika-studio/pikacli.git
cd pikacli
python -m pip install -r requirements.txt
python main.py --help
Executable or source?

Installed releases use pika. When running the repository directly, replace it with python main.py.

Discoverability

A shallow, predictable command layout.

Related tools live under five namespaces. Purpose-built groups such as todo, unicode, and playground remain at the top level.

pika system

Diagnostics, updates, monitoring, and daily status.

pika network

Connectivity, DNS, status, IP, speed, and weather.

pika security

Hashes, TOTP generation, and UUIDs.

pika file

Trees, cleanup, duplicate detection, and live logs.

pika time

Countdowns, stopwatches, and age calculations.

Existing scripts still work.

Earlier paths such as pika weather and pika timer remain hidden compatibility aliases. New scripts should prefer pika network weather and pika time timer.

Use pika --help, pika GROUP --help, or pika GROUP COMMAND --help to see the exact options supported by your installed version.

Reference

Every built-in command.

The examples below use the canonical command paths and include the most useful options without hiding the simple defaults.

pika system

System

pika system doctor

Check the Python environment, connectivity, releases, and update status.

pika system update

Check for and install the latest packaged PikaCLI release.

pika system version

Show the installed version. pika -v, pika --version, and pika version also work.

pika system about

Display PikaCLI, Python, installation, and platform details.

pika system monitor [--interval SECONDS] [--simple] [--web]

Open a live CPU, memory, disk, network, battery, uptime, and process monitor.

pika system today

Render the local daily dashboard with system, network, release, Git, and project TODO information.

pika network

Network

pika network ping

Run PikaCLI's quick connectivity and startup check.

pika network pingall HOST...

Ping one or more hosts and compare status, latency, and packet loss.

pika network ip

Show useful local and public IP information without exposing unnecessary adapter details.

pika network dns DOMAIN

Resolve IPv4, IPv6, MX, NS, TXT, and CNAME records.

pika network speedtest

Measure download, upload, latency, and jitter.

pika network status [SERVICE] [--json] [--web]

Check official status data for OpenAI, GitHub, GitLab, Discord, and Cloudflare.

pika network weather [CITY] [--forecast] [--hourly] [--simple] [--json] [--units c|f]

Show current Open-Meteo weather using a city or an approximate automatic location.

pika security & pika otp

Security

pika security hash FILE

Calculate common cryptographic hashes for a local file.

pika security otp SECRET [--copy]

Generate the current TOTP code from a Base32 secret. pika otp SECRET remains supported.

pika security uuid

Generate a random UUIDv4.

pika otp hunt --pattern PATTERN [--max-attempts N] [--cores N]

Search freshly generated local test secrets for a current six-digit TOTP match.

Keep secrets private.

OTP commands run locally and contact no account or server. Never paste an important production secret into shared logs or screenshots.

pika file

Files

pika file tree [FOLDER]

Render a configurable, colorful directory tree.

pika file clean [TYPE]

Find and safely remove generated project artifacts with confirmation.

pika file duplicate FOLDER [--delete]

Group duplicate files by size and SHA-256; deletion is always interactive.

pika file log FILE [--lines N] [--filter LEVEL] [--grep TEXT] [--ignore-case] [--json] [--web]

Follow appended log data with watchdog, colors, filtering, counters, and optional web mode.

pika time

Time

pika time timer DURATION [--name NAME]

Run a drift-resistant live countdown. Durations include 30s, 90m, and 1h30m.

pika time stopwatch [--paused] [--simple]

Start an interactive stopwatch with pause, laps, reset, and a compact view.

pika time age YYYY-MM-DD

Calculate elapsed years, days, hours, and minutes from a valid date.

Project tools

Build, explore, and stay organized.

pika template TEMPLATE

Create a common project file from a built-in template.

pika playground python|node|cpp|c|java|rust

Create a timestamped scratch project and open it in VS Code when available.

pika playground list

List existing temporary playgrounds.

pika playground open NAME

Open an existing playground.

pika playground clean

Review and remove older playgrounds.

pika todo or pika todo list

List checklist tasks from the nearest project .pikatodo file.

pika todo init

Create .pikatodo explicitly in the current project.

pika todo add TITLE

Append a new pending Markdown checklist item.

pika todo done NUMBER / pika todo undo NUMBER

Complete or reopen a numbered task.

pika todo edit NUMBER TITLE / pika todo remove NUMBER

Rename or remove one checklist item while preserving surrounding Markdown.

pika todo clean / pika todo stats / pika todo search QUERY

Clean completed tasks, view progress, or search titles.

pika unicode info VALUE

Inspect a character or code point, including names, encodings, and escapes.

pika unicode search QUERY / pika unicode random

Search assigned names or choose a random assigned character.

pika unicode list [--start VALUE] [--end VALUE]

Print a formatted Unicode range.

pika unicode export FILE [--all] / pika unicode stats

Export Unicode records or summarize the runtime Unicode database.

pika qos start --user USER --rootpass PASSWORD

Boot the isolated, non-persistent Quick Operating System shell in memory.

Sharing & utilities

Useful tools that stay simple.

pika qr TEXT

Generate QR codes and use the available scan or Wi-Fi QR workflows.

pika fileshare [PATH]

Share a local file or folder through a temporary browser interface on your network.

pika startservice pikachat

Start an ephemeral local-network PikaChat room.

pika coinflip [--fast]

Flip a coin with a smooth Rich animation, or reveal immediately.

pika download

Open the official website download section in the default browser.

Integrations

Focused external workflows.

pika git pushto -m MESSAGE

Stage, commit, and push the current Git repository with one guided command.

pika roblox profile USERNAME

Display a Roblox user's public profile information.

Guides

Common workflows.

01

Live system monitoring

Use the full terminal dashboard, a compact line, or browser mode.

pika system monitor --interval 0.5
02

Weather anywhere

Automatic location needs no API key; a city name overrides it.

pika network weather "New York" --forecast
03

Follow an application log

Read the last 100 lines and show only matching errors.

pika file log server.log --lines 100 --filter ERROR
04

Project TODO

Create the file intentionally, then manage its Markdown checklist.

pika todo init
05

Local OTP Hunt

? matches one digit and * matches variable digits.

pika otp hunt -p "2025??" --cores 4
06

Quick Operating System

Start a RAM-only shell whose session disappears completely on exit.

pika qos start --user zeke --rootpass PASSWORD

QoS shell commands

QoS v0.1 includes only help, clear, pwd, echo, hostname, whoami, date, uptime, version, neofetch, and exit. It never modifies the host filesystem or changes real privileges.

Stopwatch controls

Space
Pause or resume.
L
Record a lap.
R
Reset the stopwatch.
Q or Ctrl+C
Exit cleanly.

Help

Troubleshooting

How do I see every option for a command?

Append --help to any level, for example pika network weather --help or pika todo --help.

Why is an online value unavailable?

Network commands use short timeouts and fail gracefully. Check your connection with pika system doctor, then retry. Local portions continue working offline.

Why does the TODO command say no .pikatodo was found?

PikaCLI searches from the current directory toward the filesystem root and never creates the file automatically. Run pika todo init in the project root.

Where should I report a bug?

Open an issue in the PikaCLI GitLab project and include your platform, PikaCLI version, command, and expected result.