Installation Guide

Step-by-step instructions to install and configure our software components.

← Back to Documentation

🚀 Quick Start Installation

Use these commands to install the core application in under 2 minutes.

$ curl -fsSL https://installation.product.io/install.sh | bash
$ source ~/.bashrc
product-cli --version
$10k+
Installations

Select Your System

Install on macOS

1

Install Homebrew

If you don't have Homebrew installed, run:

/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
2

Install the Application

Use Homebrew to install the application:

brew install product-cli
3

Verify Installation

Check the installation was successful:

product-cli --version

Install on Linux

1

Download the Binary

Fetch the latest release package:

curl -L https://product.io/downloads/latest/linux.tar.gz -o product.tar.gz tar -xvf product.tar.gz
2

Make Executable

Set execute permission:

chmod +x product-cli
3

Verify Installation

Check the installation was successful:

./product-cli --version

Install on Windows

1

Download Installer

Get the Windows installer package:

Invoke-WebRequest -Uri "https://product.io/downloads/windows/installer.exe" -OutFile "product-installer.exe"
2

Run Installer

Start the installation:

.\product-installer.exe
3

Verify Installation

Check the installation was successful:

product-cli --version

Install with Docker

1

Pull Image

Get the Docker image:

docker pull productio/product-cli:latest
2

Run Container

Create and run your container:
docker run -it --name product-cli \\ -v ~/.product:/data \\ productio/product-cli:latest \\ --version
Mountss: /data
3

Access CLI

Run commands from the container:

docker exec -it product-cli product-cli --help

Configuration Basics

Configuration File Format

Create a configuration file in your preferred format. Supported formats: JSON, YAML, TOML

{ "api": { "url": "https://api.product.io", "token": "your-secure-api-token", "timeout": 30000 }, "features": { "experimental": false, "logs": { "level": "info", "filename": "/var/log/product.log" } } }

Setting Configuration

Configure using file or environment variables. Priority order: CLI > File > Environment

1. File
~/.product/config.yaml
2. CLI
product-cli --config myconfig.json ...
3. Env
PRODUCT_API=production

Default Configuration

If no configuration specified, the following defaults are used:

Setting Default Value
Log Level warn
Connection Timeout 10000 ms
Cache Path ~/.product/cache
Auto-Update true

Installation Status

Binary Location

/usr/local/bin/product-cli
Installed ✅

Configuration

~/.product/config.yml
Default Used ⚠️

Dependencies

  • OpenSSL 3.0
  • libcurl 7.80+
  • Zstandard 1.5+

Troubleshooting Common Issues