Protokol Toolkit

A command-line toolkit for managing Protokol platform applications, profiles, functions, and components.

Installation

npm install -g @ptkl/toolkit

Getting Started

1. Initialize the Toolkit

Before using the toolkit, initialize it to create the configuration directory:

ptkl init

This creates a ~/.ptkl directory where profiles and settings are stored.

2. Create a Profile

A profile stores your authentication credentials and connection settings for a Protokol instance.

Secure Method (Recommended)

Omit the password or use --password flag without a value to be prompted securely:

ptkl profile new \
  -n production \
  -u [email protected] \
  -P my-project \
  -h https://api.example.com \
  --password

You'll be prompted to enter your password securely (hidden input).

With Password in CLI (Not Recommended)

ptkl profile new \
  -n production \
  -u [email protected] \
  -P my-project \
  -h https://api.example.com \
  --password "myPassword"

⚠️ Security Warning: This will show a warning as the password may be visible in shell history.

Options

• -n, --name <name> - Profile name (e.g., "production", "staging")
• -u, --username <username> - Email or API username
• -P, --project <project> - Project identifier
• -h, --host <host> - API host URL
• -p, --password [password] - Password (optional value for secure prompt)

Profile Management

List All Profiles

ptkl profile list

Shows all available profiles. The currently active profile is marked with *.

View Current Profile

ptkl profile

Switch to a Different Profile

ptkl profile use staging

Sets staging as the active profile for all subsequent commands.

Inspect Profile Details

ptkl profile inspect production

Re-authenticate a Profile

If your token expires or you need to update credentials:

ptkl profile auth --password

Or for a specific profile:

ptkl profile auth --profile production --password

Options

• -p, --password [password] - Password (omit value for secure prompt)
• -t, --token <token> - Directly provide a token
• -P, --project <project> - Update the project

Delete a Profile

ptkl profile delete staging

Using the --profile Flag

You can override the active profile for any command using the global --profile flag:

ptkl --profile production apps upload -a app -d ./my-app

Version

Current version: 0.7.0

License

GNU General Public License v3.0 (GPL-3.0)

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

Any modifications or derivative works must also be licensed under GPL-3.0 and the source code must be made available.