Skip to main content

Command-line interface for Kolay IK (https://apidocs.kolayik.com)

Project description

CLI and MCP Server for Kolay IK

               ███████████████████████
              ████               ████ 
             ████               ████ 
            ████               ████          ████                             ███ 
           ███                ████           ████                             ███ 
         ████                ███             ████                             ███ 
        ████               ████              ████     █████    █████████      ███     █████████ ████  ████        ████ 
       ████               ████               ████   █████    █████████████    ███    ███████████████   ████      ████ 
      ████               ████                ████  ████     ████       ████   ███   ████       █████    ███     ████ 
       ████             ██████               ████████      ████         ████  ███  ████         ████    ████    ███ 
        ████           ████████              ████████      ████         ████  ███  ████         ████     ████  ████ 
         ████         ███   ████             ████ █████    ████         ████  ███  ████         ████      ████████ 
          ████      ████     ████            ████   ████    █████     █████   ███   █████     ██████       ██████ 
           ████    ████        ███           ████     ████    ███████████     ███     ██████████████        █████ 
             ███  ████          ████                             █████                   ████               ████ 
              ███████            ████                                                                      ████ 
               ███████████████████████                                                                  ██████ 
                █████████████████████                                                                   ███ 

Manage employees, leaves, and payroll from your terminal — or through any AI assistant that speaks MCP.


[QUICK START]

1. Install

pipx install kolay-cli
# or: pip install kolay-cli

2. Configure

kolay setup
# follow the prompts to authenticate and enable autocompletion

3. Verify

kolay doctor

[OPENAI CHATGPT CONNECTION]

ChatGPT speaks MCP now. But its Beta connector has no custom header support. We solved it. Your token rides in the URL.

  1. Open chatgpt.com. Click your profile icon. Go to Settings.
  2. Find Connectors (under Apps). Click Add (the "+" button).
  3. The New App dialog opens. Fill in:
    • Name: Kolay IK
    • Description: HR management -- employees, leaves, timelogs, trainings, payroll
    • MCP Server URL: https://kolay.up.railway.app/mcp?token=YOUR_KOLAY_API_TOKEN
    • Authentication: Select No Auth from the dropdown.
  4. Check "I understand and want to continue".
  5. Click Create.

That is all. Your AI is now an HR operator.

If your server also uses a gatekeeper key (MCP_API_KEY), append it: https://kolay.up.railway.app/mcp?token=YOUR_TOKEN&api_key=YOUR_MCP_API_KEY


[THE GATEWAYS]

Detailed documentation is now split for your convenience. Choose your journey:

CLI Documentation

For the Terminal Wizards. Full command reference, output filters, interactive pickers, and local security (Keychain + Config Encryption).

"Everything you need to master your HR data from the shell."

MCP Documentation

For the AI Architects. Connect ChatGPT, Claude, Gemini, Mistral, and more. 15 layers of security (PII Masking, DLP, Circuit Breakers).

"Turn your LLM into a fully-capable HR operations lead."

Security and Privacy

For the Compliance Officers. Zero-trust architecture, encryption at rest, PII pseudonymization, and last-mile safety layers.

"How we protect your most sensitive HR data."


[ALPHA DISCLAIMER]

  1. UNOFFICIAL. Independent lab application. Not a Kolay Yazilim A.S. product.
  2. WRITE OPERATIONS ARE REAL. This is not a sandbox. Actions modify live HR data.
  3. TOKEN SECURITY. You are responsible for your API token. Keep it private.

[EMPHATIC UX HELP GUIDE]

STOP STRUGGLING. We refuse to let technical friction slow down your HR workflows. We designed Kolay CLI to be an effortless extension of your mind. If it's not working perfectly, here is exactly how to fix it right now:

  • [UNAUTHORIZED? SHRUNKEN KEYS?] If your tools suddenly stop returning data, your API token has expired. RE-ARM IMMEDIATELY with kolay auth login. If you're running headless, let keyrings.alt securely manage your file-backed storage!
  • [NEED MORE EYES?] You hold immense power. Don't guess. Append --help (e.g., kolay person list --help) to instantly reveal the hidden arsenals of filters, limits, and operational flags!
  • [TALK TO PROTOCOLS?] Switch to --json to obliterate the pretty tables and output razor-sharp, structured JSON. Pipe it directly into jq and command your data like a true terminal wizard!
  • [FEELING THE LAG?] We forged this client for raw speed. If it stutters, check your network or the Kolay status page—we do not compromise on performance!
  • [VIEW THE MAP] Lost your bearings? Run kolay config show. It acts as your absolute compass, instantly exposing your active environment, base URL, and operational settings!
  • [ZERO TRUST, ZERO DRAMA] Paralyzed by privacy concerns? Read our security documentation. We enforce ruthless PII masking, DLP egress scanners, and military-grade on-device AES-256-GCM encryption by default.

You are never alone. Every error we throw is a tactical guide, never a dead end. If you hit an impenetrable wall, report it and we will tear it down together!


[THE STACK]

  • Python 3.10+
  • Typer (Interactive CLI)
  • FastMCP (Verifiable Smart Proxy)
  • AES-256-GCM (AEAD Configuration & Memory Encryption)
  • HMAC-SHA256 (PII Masking + Execution Receipts)

[LICENSE]

MIT

Project details


Release history Release notifications | RSS feed

Download files

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

Source Distribution

kolay_cli-0.13.0b1.tar.gz (234.0 kB view details)

Uploaded Source

Built Distribution

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

kolay_cli-0.13.0b1-py3-none-any.whl (213.6 kB view details)

Uploaded Python 3

File details

Details for the file kolay_cli-0.13.0b1.tar.gz.

File metadata

  • Download URL: kolay_cli-0.13.0b1.tar.gz
  • Upload date:
  • Size: 234.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kolay_cli-0.13.0b1.tar.gz
Algorithm Hash digest
SHA256 7eb96d9752ee5b66153cc4e60059a8bb9106b3fafbe2f234148071acb0a6d02e
MD5 f5ba5ee41a7a80eb26afa341c06a3a0a
BLAKE2b-256 82a21da43ae722ff1d5eba001de1bef2760350e00108145cbc44268f916e2ac5

See more details on using hashes here.

File details

Details for the file kolay_cli-0.13.0b1-py3-none-any.whl.

File metadata

  • Download URL: kolay_cli-0.13.0b1-py3-none-any.whl
  • Upload date:
  • Size: 213.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"macOS","version":null,"id":null,"libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for kolay_cli-0.13.0b1-py3-none-any.whl
Algorithm Hash digest
SHA256 077f505695ccac980d7e54beacd0461145b86e732d2b897fb24b313ddeb05227
MD5 36687d9ecc62a0752a8cbdde2ed0c7ed
BLAKE2b-256 39242ca77bd9e8aed11d73f57354f10a0f39777af3b19dea5ae18f3e59283b22

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