Skip to main content

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

Project description

Disclaimer and Legal Notice (Alpha Release)

  1. Unofficial Lab Application: This project is an independent "lab/R&D" application. It is not an official product or service of Kolay İK. Kolay Yazılım A.Ş. cannot be held responsible for any data loss, system errors, or damages arising from the use of this software.
  2. Token and Data Security: The creation and secure storage of API tokens are entirely the user's responsibility. Please follow Kolay İK's official instructions and security guidelines when generating tokens to prevent unauthorized access.
  3. Operational Risks: Please use the tools and operations performed via the MCP and CLI carefully. Write/update actions and bulk operations can cause permanent changes or damage to your live HR data.
  4. Early Development Stage (Alpha): This application is currently in its Alpha stage and is under active development. It may contain unexpected bugs. You can submit any bug reports, feedback, or feature requests via the GitHub Issues page.

kolay-cli

An unofficial AI-powered Command Line Interface and MCP Server for Kolay İK.

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

kolay-cli allows you to manage your HR tasks, employee records, and company workflows directly from your terminal. It provides lightweight access to the Kolay İK API and serves as a local Model Context Protocol (MCP) server for AI assistants like Claude and Cursor.

Key Features

  • Natural Language HR: Use the built-in MCP server to talk to your HR data using AI.
  • Complete Resource Management: Manage People, Leaves, Timelogs, Trainings, and Finance.
  • Secure by Design: API tokens are stored in your OS Keychain (macOS, Windows, Linux).
  • CLI First UX: Interactive ID pickers, human-readable tables, and guided setup.
  • Developer Friendly: Full JSON output mode for automation and scripting.
  • Health Diagnostics: Built-in doctor command to verify connectivity and credentials.

Installation

Install via pipx (recommended) to keep dependencies isolated:

pipx install kolay-cli

Or via pip:

pip install kolay-cli

Quickstart

1. Authenticate

Configure your session by providing your Kolay API token. You can generate a token at app.kolayik.com/settings/developer-settings.

kolay auth login

2. Verify Health

Ensure your connection is healthy and authorized.

kolay doctor

3. Start Managing

List your colleagues or create a leave request.

# List top 10 employees
kolay person list --limit 10

# Create an annual leave request
kolay leave create --type annual --start 2026-03-01 --end 2026-03-03

MCP Server Integration

Turn your AI assistant into an HR expert. kolay-cli exposes its full functionality as an MCP server.

Local Clients (stdio)

For clients running on your machine, use the automated installer:

kolay mcp install

This writes the configuration into the correct file for each client. Supported local clients:

Client Config Path
Claude Desktop ~/Library/Application Support/Claude/claude_desktop_config.json
Cursor (global) ~/.cursor/mcp.json
Cursor (project) .cursor/mcp.json in your working directory
Windsurf ~/.codeium/windsurf/mcp_config.json
Gemini CLI ~/.gemini/settings.json
VS Code (Copilot) User-level mcp.json
Zed ~/.config/zed/settings.json

Restart your client after running kolay mcp install to activate the connection.

Mistral Le Chat (remote)

Le Chat supports MCP through remote HTTP connectors. To connect kolay-cli:

1. Start the MCP server in HTTP mode:

kolay mcp serve --transport http --port 8000

This starts the server at http://localhost:8000/mcp. If you want to expose it to the internet (for Le Chat cloud access), deploy it on a server with a public IP or use a tunnel like ngrok:

ngrok http 8000

2. Add the connector in Le Chat:

  1. Go to chat.mistral.ai/connections
  2. Click Add custom connector
  3. Enter your MCP server URL (e.g. https://your-ngrok-url.ngrok.io/mcp)
  4. Save and start chatting with your HR data

Note: The HTTP endpoint does not include authentication by default. When exposing your MCP server to the internet, use a reverse proxy with HTTPS and token-based access control.

Output Modes

Flag Description
--json Returns machine-readable JSON for prompts or scripts.
--yes Bypasses confirmation prompts for destructive actions.
--debug Logs HTTP traces to ~/.config/kolay/debug.log.

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 Distributions

No source distribution files available for this release.See tutorial on generating distribution archives.

Built Distribution

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

kolay_cli-0.10.2a0-py3-none-any.whl (95.6 kB view details)

Uploaded Python 3

File details

Details for the file kolay_cli-0.10.2a0-py3-none-any.whl.

File metadata

  • Download URL: kolay_cli-0.10.2a0-py3-none-any.whl
  • Upload date:
  • Size: 95.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.10.6 {"installer":{"name":"uv","version":"0.10.6","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.10.2a0-py3-none-any.whl
Algorithm Hash digest
SHA256 3cf27f0943f3228849cddfb5a0938f053d642c4cdd884ace8540af7ba475e997
MD5 ab1e8d9f4b03af2d821abdac46de70e5
BLAKE2b-256 72a6e860a8d5ba40cfcf9dd84185af63f453998c215d6d4981083a70a59ae4cc

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