polaris-terminal 0.1.1

CLI tool for connecting to Polaris containers via terminal

Polaris Terminal

A command-line tool for connecting to Polaris containers via terminal.

Installation

From Source

# Clone the repository
git clone https://github.com/polaris/polaris-terminal.git
cd polaris-terminal

# Install the package
pip install -e .

Using pip

pip install polaris-terminal

Using Installer Script

# Download and run the installer
python install_polaris_terminal.py

Initial Setup

After installation, you must configure your miner ID:

# Set your miner ID (required for security reasons)
polaris config --miner-id YOUR_MINER_ID

Usage

List Available Containers

To list containers, you must either specify a container or configure your miner ID:

# List all containers for your miner ID (after configuring)
polaris list

# List containers for a specific container (safer, no miner ID required)
polaris list --container polaris-pod-1743999981-pod-1

Show Container Details

View detailed information about a container. You can use either the container name or pod ID:

polaris info polaris-pod-1743999981-pod-1

Or using just the pod ID:

polaris info pod-1

Or using the timestamp part of the container name:

polaris info 1743999981-pod-1

Connect to a Container

Connect to a container terminal. Multiple formats are supported:

# Using full container name
polaris connect polaris-pod-1743999981-pod-1

# Using pod ID
polaris connect pod-1

# Using timestamp part
polaris connect 1743999981-pod-1

Configure Default Settings

View current configuration:

polaris config --show

Set default server URL:

polaris config --server-url https://polaris-test-server.onrender.com

Set your miner ID (required for security):

polaris config --miner-id YOUR_MINER_ID

Specify Server URL for a Single Command

polaris connect polaris-pod-1743999981-pod-1 --server-url https://polaris-test-server.onrender.com

Show Verbose Output

For detailed diagnostic information:

polaris connect polaris-pod-1743999981-pod-1 --verbose

Features

• Privacy-Focused: Only access your own containers by using your miner ID
• Smart Container Name Handling: Works with full container names, pod IDs, or partial names
• Automatic Miner ID Detection: Automatically detects the correct miner ID for each container
• WebSocket Terminal: Connect to container terminals via WebSocket
• Detailed Container Information: View complete details about containers
• Configuration Management: Persistent configuration stored in JSON file
• Cross-Platform: Works on Windows, Linux, and macOS
• Robust Error Handling: Helpful error messages and diagnostics

Container Name Formats

The tool intelligently handles different formats for container identification:

• Full Container Name: polaris-pod-1743999981-pod-1
• Pod ID: pod-1
• Timestamp Format: 1743999981-pod-1

All these formats will be automatically detected and handled correctly.

Security

For security and privacy reasons:

• You must configure your own miner ID to list all containers
• When connecting to a specific container, the tool will automatically detect the correct miner ID
• No hardcoded miner IDs are included in the package

Configuration

The tool stores its configuration in ~/.polaris/config.json. You can edit this file directly or use the polaris config command to update settings.

Default configuration:

{
  "server_url": "https://polaris-test-server.onrender.com",
  "miner_id": "EXAMPLE-MINER-ID-REPLACE-THIS"
}

Troubleshooting

If you encounter connection issues:

1. Check your server URL with polaris config --show
2. Ensure you've set your miner ID with polaris config --miner-id YOUR_MINER_ID
3. Try using the pod ID directly with polaris connect pod-1
4. Use the --verbose flag for detailed diagnostics
5. Try accessing the web terminal directly in your browser at https://polaris-test-server.onrender.com/api/v1/containers/{container_name}/terminal

Requirements

• Python 3.7 or higher
• requests library
• websockets library