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

🏛️ 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."


⚠️ 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! Don't let a technical hurdle slow you down. We are obsessed with making your HR workflow feel effortless. If things aren't "just working," here is exactly how to fix it:

  • 🔑 SHRUNKEN KEYS? If your tools aren't returning data, your token has likely expired. RE-ARM IMMEDIATELY with kolay auth login. If you're on a headless server, the keyrings.alt package is your best friend for secure, file-backed storage!
  • 🧐 NEED MORE EYES? Every single command is documented for you. Append --help (e.g., kolay person list --help) to reveal the full hidden power of filters, limits, and flags!
  • 🤖 TALK TO THE MACHINE? Switching to --json transforms beautiful tables into perfectly structured data. Pipe it to jq and become a terminal wizard!
  • 🐌 FEELING THE LAG? We use the blazing-fast httpx client under the hood. If things aren't snappy, check the Kolay status page or your network — we're built for speed!
  • 🗺️ VIEW THE MAP. Lost in your own data? kolay config show acts as your compass, showing exactly where you're pointing and which settings are in control!
  • 🛡️ ZERO TRUST, ZERO DRAMA. Worried about privacy? Check our security docs. We implement PII masking, DLP, and and on-device encryption by default.

You aren't alone. Every error we throw is a guide, not a dead end. If you hit a wall, report it and we'll tear it down together!


🛠️ THE STACK

  • Python 3.10+
  • Typer (Interactive CLI)
  • FastMCP (Verifiable Smart Proxy)
  • Fernet / AES-128-CBC (Config 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.0a4.tar.gz (217.8 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.0a4-py3-none-any.whl (201.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: kolay_cli-0.13.0a4.tar.gz
  • Upload date:
  • Size: 217.8 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.0a4.tar.gz
Algorithm Hash digest
SHA256 26d4d268778d6c4d853f1447fc33c1e98c4f1cb4289374aead9b9d0d6000166f
MD5 94d52b88607f2f721fce217e7fff3980
BLAKE2b-256 a1b0049a78d3c87b93918b0feeaa81b9fbddcd2089b61af95c23057818db0ebe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: kolay_cli-0.13.0a4-py3-none-any.whl
  • Upload date:
  • Size: 201.2 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.0a4-py3-none-any.whl
Algorithm Hash digest
SHA256 5c6ba6a5a17427ad0e7432d74ef6dcee7e3a2756026eb88ad76a66a8f430a21d
MD5 365014583eadbed9f0bf0df4f4eaba25
BLAKE2b-256 cf3acf2edd66e6714a3ac768606494df306692b439833f7d3a4348c66cbf3919

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