Skip to main content

A suite of CLI utilities for account pool and device spy services.

Project description

RC CLI - Development Tools

A powerful command-line tool for development workflows.

📦 Installation

pip install rc-cli-tools

Or install from source:

git clone <repository-url>
cd utils-kts
# Recommended: install into the project venv so you run the matching `rc`
python3 -m venv .venv
./.venv/bin/pip install -e .

# Use the venv's rc explicitly (or activate the venv)
./.venv/bin/rc --help

⚙️ Configuration

First-Time Setup (Recommended)

After installation, configure RC CLI using the interactive setup:

rc config setup

This will:

  • Guide you through the configuration process
  • Create ~/.rc-cli.env with your settings
  • Validate the configuration

Quick Check

# View current configuration
rc config show

# Validate configuration
rc config validate

Manual Configuration (Alternative)

Create ~/.rc-cli.env in your home directory:

# Copy the example file
cp .env.example ~/.rc-cli.env

# Edit with your actual values
# IMPORTANT: Replace 'yourcompany' with your actual company domain
vim ~/.rc-cli.env

Example configuration:

# Company name (for file naming)
COMPANY_NAME=YourCompany

# GitLab Configuration (IMPORTANT: Include /api/v4)
SP_GITLAB_BASE_URL=https://git.yourcompany.com/api/v4
SP_GITLAB_PROJECT_ID=24890
GITLAB_TOKEN=your-gitlab-personal-access-token

# mThor Account Pool GitLab Configuration (recommended)
MTHOR_GITLAB_BASE_URL=https://git.yourcompany.com/api/v4
MTHOR_GITLAB_PROJECT_ID=12345
MTHOR_GITLAB_FILE_PATH=src/main/resources/account/mThor-mZeus-account.yaml
MTHOR_GITLAB_BRANCH=master

# Internal APIs
SP_INTAPI_BASE_URL=http://intapi.yourcompany.com:8082
AP_BASE_URL=https://account-pool.yourcompany.com
DS_BASE_URL=https://device-spy.yourcompany.com

Important:

  • The .rc-cli.env file in your home directory is global for all projects
  • You can also create a .env file in specific project directories
  • Never commit .env files to version control

Configuration Locations

RC CLI searches for configuration in this order (first found wins):

  1. .env in current directory (project-specific)
  2. ~/.rc-cli.env in your home directory (global)
  3. Environment variables in your shell (highest priority)

Getting GitLab Token

  1. Go to GitLab → User Settings → Access Tokens
  2. Create a new token with read_api scope
  3. Copy the token and use it in your configuration

🚀 Quick Start

# Check configuration
rc config

# Service Parameters
rc sp tui              # Interactive TUI (recommended)
rc sp list             # List all service parameters
rc sp search 'SMS'     # Search for parameters

# Feature Flags
rc ffs tui             # Interactive TUI
rc ffs search 'flag'   # Search flags

# Account Pool
rc ap tui                      # Interactive TUI (includes all features below)
rc ap get webAqaXmn            # Get random account
rc ap by-alias webAqaXmn       # Get account by alias from GitLab
rc ap list-aliases             # List all available aliases
rc ap alias-info webAqaXmn     # Get alias details

# Device Spy
rc ds udid <UDID>              # Get device info
rc ds devices android          # List devices

# Downloads
rc download aqa        # Download AQA apps

📖 Documentation

For detailed documentation, visit [Documentation Link] or run:

rc info

🔐 Security Notes

  • Never commit .env files to version control
  • Use GitLab personal access tokens, not passwords
  • Keep your tokens secure and rotate them regularly

🐛 Troubleshooting

"GitLab URL not configured" Error

This means you haven't set up your configuration yet:

# Check configuration status
rc config show

# Run setup wizard
rc config setup

Configuration Not Loading

# Check which config files exist
rc config show

# Verify file location
ls -la ~/.rc-cli.env

DNS Resolution Errors

If you see "nodename nor servname provided" error:

  • Your SP_GITLAB_BASE_URL is using the default placeholder
  • Run rc config setup to set the correct GitLab URL
  • Or edit ~/.rc-cli.env with your actual GitLab server URL

📚 Documentation

📝 License

[Your License Here]

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

my_cli_utilities-0.4.7.tar.gz (94.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

my_cli_utilities-0.4.7-py3-none-any.whl (137.7 kB view details)

Uploaded Python 3

File details

Details for the file my_cli_utilities-0.4.7.tar.gz.

File metadata

  • Download URL: my_cli_utilities-0.4.7.tar.gz
  • Upload date:
  • Size: 94.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.11.4

File hashes

Hashes for my_cli_utilities-0.4.7.tar.gz
Algorithm Hash digest
SHA256 4469490c644e1483440a0b3988874d14be11519f52980adbd69e27b2cde025b7
MD5 6b1e9dcda36f1110a0773288db98c10c
BLAKE2b-256 3a48b7d4b5bd32b6cd7a8a0dceb17d7940abdff438e777803b13882635ab052d

See more details on using hashes here.

File details

Details for the file my_cli_utilities-0.4.7-py3-none-any.whl.

File metadata

File hashes

Hashes for my_cli_utilities-0.4.7-py3-none-any.whl
Algorithm Hash digest
SHA256 33f3f220a58e939a45321834994c68d1d398970dadaa58adc2c1fd6e5fcefb53
MD5 b995c61bca731237a819ef0305328d0d
BLAKE2b-256 fdba9c1e28db08a2d9846a3cbed735bcdfa2e94e4f00146a648b981d64323c13

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page