@gaberoo/kalshitools 1.0.0

package/README.md

@@ -0,0 +1,666 @@
+# kalshitools
+
+A powerful CLI tool for interacting with the Kalshi prediction markets API. Built for traders, automated systems, and AI agents.
+
+[![oclif](https://img.shields.io/badge/cli-oclif-brightgreen.svg)](https://oclif.io)
+[![Version](https://img.shields.io/npm/v/kalshitools.svg)](https://npmjs.org/package/kalshitools)
+[![License](https://img.shields.io/npm/l/kalshitools.svg)](https://github.com/kalshitools/kalshitools/blob/main/package.json)
+
+## Features
+
+- 🔐 **Secure Authentication**: RSA-PSS based authentication with secure credential storage
+- 📊 **Market Data**: Browse and query prediction markets (coming soon)
+- 💼 **Portfolio Management**: View balances and positions (coming soon)
+- 📈 **Trading**: Place and manage orders with safety features (coming soon)
+- 🤖 **AI-Friendly**: Structured JSON output for automated systems
+- 🛡️ **Safety First**: Demo environment default, confirmations, and order limits
+
+## Quick Start
+
+```bash
+# Initialize configuration
+kalshitools config init
+
+# Verify configuration
+kalshitools config show
+
+# Get JSON output
+kalshitools config show --json
+```
+
+## Configuration
+
+Configuration is stored at `~/.config/kalshitools/config.json` and can be overridden with environment variables:
+
+```bash
+export KALSHI_ENV=demo
+export KALSHI_API_KEY_ID=your-email@example.com
+export KALSHI_PRIVATE_KEY_PATH=~/.kalshitools/demo-private-key.pem
+export LOG_LEVEL=info
+```
+
+<!-- toc -->
+* [kalshitools](#kalshitools)
+* [Initialize configuration](#initialize-configuration)
+* [Verify configuration](#verify-configuration)
+* [Get JSON output](#get-json-output)
+* [Usage](#usage)
+* [Commands](#commands)
+<!-- tocstop -->
+# Usage
+<!-- usage -->
+```sh-session
+$ npm install -g @gaberoo/kalshitools
+$ kalshitools COMMAND
+running command...
+$ kalshitools (--version)
+@gaberoo/kalshitools/1.0.0 darwin-arm64 node-v22.20.0
+$ kalshitools --help [COMMAND]
+USAGE
+  $ kalshitools COMMAND
+...
+```
+<!-- usagestop -->
+# Commands
+<!-- commands -->
+* [`kalshitools config init`](#kalshitools-config-init)
+* [`kalshitools config show`](#kalshitools-config-show)
+* [`kalshitools help [COMMAND]`](#kalshitools-help-command)
+* [`kalshitools markets list`](#kalshitools-markets-list)
+* [`kalshitools markets show TICKER`](#kalshitools-markets-show-ticker)
+* [`kalshitools orders cancel ORDERID`](#kalshitools-orders-cancel-orderid)
+* [`kalshitools orders create`](#kalshitools-orders-create)
+* [`kalshitools orders list`](#kalshitools-orders-list)
+* [`kalshitools plugins`](#kalshitools-plugins)
+* [`kalshitools plugins add PLUGIN`](#kalshitools-plugins-add-plugin)
+* [`kalshitools plugins:inspect PLUGIN...`](#kalshitools-pluginsinspect-plugin)
+* [`kalshitools plugins install PLUGIN`](#kalshitools-plugins-install-plugin)
+* [`kalshitools plugins link PATH`](#kalshitools-plugins-link-path)
+* [`kalshitools plugins remove [PLUGIN]`](#kalshitools-plugins-remove-plugin)
+* [`kalshitools plugins reset`](#kalshitools-plugins-reset)
+* [`kalshitools plugins uninstall [PLUGIN]`](#kalshitools-plugins-uninstall-plugin)
+* [`kalshitools plugins unlink [PLUGIN]`](#kalshitools-plugins-unlink-plugin)
+* [`kalshitools plugins update`](#kalshitools-plugins-update)
+* [`kalshitools portfolio balance`](#kalshitools-portfolio-balance)
+* [`kalshitools portfolio fills`](#kalshitools-portfolio-fills)
+* [`kalshitools portfolio positions`](#kalshitools-portfolio-positions)
+
+## `kalshitools config init`
+
+Initialize kalshitools configuration interactively
+
+```
+USAGE
+  $ kalshitools config init [--json] [--env demo|production] [--keyId <value>] [--privateKeyPath <value>]
+
+FLAGS
+  --env=<option>            [default: demo] Environment to configure (demo or production)
+                            <options: demo|production>
+  --json                    Output in JSON format
+  --keyId=<value>           API key ID (email)
+  --privateKeyPath=<value>  Path to private key file
+
+DESCRIPTION
+  Initialize kalshitools configuration interactively
+
+EXAMPLES
+  $ kalshitools config init
+
+  $ kalshitools config init --env production
+```
+
+_See code: [src/commands/config/init.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/config/init.ts)_
+
+## `kalshitools config show`
+
+Show current configuration (credentials redacted)
+
+```
+USAGE
+  $ kalshitools config show [--json]
+
+FLAGS
+  --json  Output in JSON format
+
+DESCRIPTION
+  Show current configuration (credentials redacted)
+
+EXAMPLES
+  $ kalshitools config show
+
+  $ kalshitools config show --json
+```
+
+_See code: [src/commands/config/show.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/config/show.ts)_
+
+## `kalshitools help [COMMAND]`
+
+Display help for kalshitools.
+
+```
+USAGE
+  $ kalshitools help [COMMAND...] [-n]
+
+ARGUMENTS
+  [COMMAND...]  Command to show help for.
+
+FLAGS
+  -n, --nested-commands  Include all nested commands in the output.
+
+DESCRIPTION
+  Display help for kalshitools.
+```
+
+_See code: [@oclif/plugin-help](https://github.com/oclif/plugin-help/blob/v6.2.37/src/commands/help.ts)_
+
+## `kalshitools markets list`
+
+List prediction markets
+
+```
+USAGE
+  $ kalshitools markets list [--json] [--status active|closed|settled|finalized] [--limit <value>]
+
+FLAGS
+  --json             Output in JSON format
+  --limit=<value>    [default: 20] Maximum number of markets to return
+  --status=<option>  Filter by market status
+                     <options: active|closed|settled|finalized>
+
+DESCRIPTION
+  List prediction markets
+
+EXAMPLES
+  $ kalshitools markets list
+
+  $ kalshitools markets list --status active --limit 10
+
+  $ kalshitools markets list --json
+```
+
+_See code: [src/commands/markets/list.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/markets/list.ts)_
+
+## `kalshitools markets show TICKER`
+
+Show market details
+
+```
+USAGE
+  $ kalshitools markets show TICKER [--json]
+
+ARGUMENTS
+  TICKER  Market ticker symbol
+
+FLAGS
+  --json  Output in JSON format
+
+DESCRIPTION
+  Show market details
+
+EXAMPLES
+  $ kalshitools markets show TICKER
+
+  $ kalshitools markets show TICKER --json
+```
+
+_See code: [src/commands/markets/show.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/markets/show.ts)_
+
+## `kalshitools orders cancel ORDERID`
+
+Cancel an order
+
+```
+USAGE
+  $ kalshitools orders cancel ORDERID [--json] [-y]
+
+ARGUMENTS
+  ORDERID  Order ID to cancel
+
+FLAGS
+  -y, --yes   Skip confirmation prompt
+      --json  Output in JSON format
+
+DESCRIPTION
+  Cancel an order
+
+EXAMPLES
+  $ kalshitools orders cancel ORDER_ID
+
+  $ kalshitools orders cancel ORDER_ID --yes
+
+  $ kalshitools orders cancel ORDER_ID --json
+```
+
+_See code: [src/commands/orders/cancel.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/orders/cancel.ts)_
+
+## `kalshitools orders create`
+
+Create a new order (buy or sell contracts)
+
+```
+USAGE
+  $ kalshitools orders create -t <value> -a buy|sell -s yes|no -q <value> [--json] [--type market|limit] [-p
+    <value>] [-y] [--dry-run]
+
+FLAGS
+  -a, --action=<option>   (required) Order action (buy or sell)
+                          <options: buy|sell>
+  -p, --price=<value>     Limit price (required for limit orders, 0.01-0.99)
+  -q, --quantity=<value>  (required) Number of contracts
+  -s, --side=<option>     (required) Contract side (yes or no)
+                          <options: yes|no>
+  -t, --ticker=<value>    (required) Market ticker symbol
+  -y, --yes               Skip confirmation prompt
+      --dry-run           Simulate the order without actually placing it
+      --json              Output in JSON format
+      --type=<option>     [default: market] Order type (market or limit)
+                          <options: market|limit>
+
+DESCRIPTION
+  Create a new order (buy or sell contracts)
+
+EXAMPLES
+  $ kalshitools orders create --ticker TICKER --action buy --side yes --quantity 10 --type market
+
+  $ kalshitools orders create --ticker TICKER --action buy --side yes --quantity 10 --type limit --price 0.65
+
+  $ kalshitools orders create --ticker TICKER --action sell --side no --quantity 5 --type market --yes
+
+  $ kalshitools orders create --ticker TICKER --action buy --side yes --quantity 100 --dry-run
+```
+
+_See code: [src/commands/orders/create.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/orders/create.ts)_
+
+## `kalshitools orders list`
+
+List orders
+
+```
+USAGE
+  $ kalshitools orders list [--json] [--status pending|resting|canceled|executed|expired] [--ticker <value>]
+    [--limit <value>]
+
+FLAGS
+  --json             Output in JSON format
+  --limit=<value>    [default: 50] Maximum number of orders to return
+  --status=<option>  Filter by order status
+                     <options: pending|resting|canceled|executed|expired>
+  --ticker=<value>   Filter by ticker
+
+DESCRIPTION
+  List orders
+
+EXAMPLES
+  $ kalshitools orders list
+
+  $ kalshitools orders list --status resting
+
+  $ kalshitools orders list --ticker TICKER
+
+  $ kalshitools orders list --json
+```
+
+_See code: [src/commands/orders/list.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/orders/list.ts)_
+
+## `kalshitools plugins`
+
+List installed plugins.
+
+```
+USAGE
+  $ kalshitools plugins [--json] [--core]
+
+FLAGS
+  --core  Show core plugins.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  List installed plugins.
+
+EXAMPLES
+  $ kalshitools plugins
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/index.ts)_
+
+## `kalshitools plugins add PLUGIN`
+
+Installs a plugin into kalshitools.
+
+```
+USAGE
+  $ kalshitools plugins add PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into kalshitools.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the KALSHITOOLS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the KALSHITOOLS_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ kalshitools plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ kalshitools plugins add myplugin
+
+  Install a plugin from a github url.
+
+    $ kalshitools plugins add https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ kalshitools plugins add someuser/someplugin
+```
+
+## `kalshitools plugins:inspect PLUGIN...`
+
+Displays installation properties of a plugin.
+
+```
+USAGE
+  $ kalshitools plugins inspect PLUGIN...
+
+ARGUMENTS
+  PLUGIN...  [default: .] Plugin to inspect.
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Displays installation properties of a plugin.
+
+EXAMPLES
+  $ kalshitools plugins inspect myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/inspect.ts)_
+
+## `kalshitools plugins install PLUGIN`
+
+Installs a plugin into kalshitools.
+
+```
+USAGE
+  $ kalshitools plugins install PLUGIN... [--json] [-f] [-h] [-s | -v]
+
+ARGUMENTS
+  PLUGIN...  Plugin to install.
+
+FLAGS
+  -f, --force    Force npm to fetch remote resources even if a local copy exists on disk.
+  -h, --help     Show CLI help.
+  -s, --silent   Silences npm output.
+  -v, --verbose  Show verbose npm output.
+
+GLOBAL FLAGS
+  --json  Format output as json.
+
+DESCRIPTION
+  Installs a plugin into kalshitools.
+
+  Uses npm to install plugins.
+
+  Installation of a user-installed plugin will override a core plugin.
+
+  Use the KALSHITOOLS_NPM_LOG_LEVEL environment variable to set the npm loglevel.
+  Use the KALSHITOOLS_NPM_REGISTRY environment variable to set the npm registry.
+
+ALIASES
+  $ kalshitools plugins add
+
+EXAMPLES
+  Install a plugin from npm registry.
+
+    $ kalshitools plugins install myplugin
+
+  Install a plugin from a github url.
+
+    $ kalshitools plugins install https://github.com/someuser/someplugin
+
+  Install a plugin from a github slug.
+
+    $ kalshitools plugins install someuser/someplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/install.ts)_
+
+## `kalshitools plugins link PATH`
+
+Links a plugin into the CLI for development.
+
+```
+USAGE
+  $ kalshitools plugins link PATH [-h] [--install] [-v]
+
+ARGUMENTS
+  PATH  [default: .] path to plugin
+
+FLAGS
+  -h, --help          Show CLI help.
+  -v, --verbose
+      --[no-]install  Install dependencies after linking the plugin.
+
+DESCRIPTION
+  Links a plugin into the CLI for development.
+
+  Installation of a linked plugin will override a user-installed or core plugin.
+
+  e.g. If you have a user-installed or core plugin that has a 'hello' command, installing a linked plugin with a 'hello'
+  command will override the user-installed or core plugin implementation. This is useful for development work.
+
+
+EXAMPLES
+  $ kalshitools plugins link myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/link.ts)_
+
+## `kalshitools plugins remove [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ kalshitools plugins remove [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ kalshitools plugins unlink
+  $ kalshitools plugins remove
+
+EXAMPLES
+  $ kalshitools plugins remove myplugin
+```
+
+## `kalshitools plugins reset`
+
+Remove all user-installed and linked plugins.
+
+```
+USAGE
+  $ kalshitools plugins reset [--hard] [--reinstall]
+
+FLAGS
+  --hard       Delete node_modules and package manager related files in addition to uninstalling plugins.
+  --reinstall  Reinstall all plugins after uninstalling.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/reset.ts)_
+
+## `kalshitools plugins uninstall [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ kalshitools plugins uninstall [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ kalshitools plugins unlink
+  $ kalshitools plugins remove
+
+EXAMPLES
+  $ kalshitools plugins uninstall myplugin
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/uninstall.ts)_
+
+## `kalshitools plugins unlink [PLUGIN]`
+
+Removes a plugin from the CLI.
+
+```
+USAGE
+  $ kalshitools plugins unlink [PLUGIN...] [-h] [-v]
+
+ARGUMENTS
+  [PLUGIN...]  plugin to uninstall
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Removes a plugin from the CLI.
+
+ALIASES
+  $ kalshitools plugins unlink
+  $ kalshitools plugins remove
+
+EXAMPLES
+  $ kalshitools plugins unlink myplugin
+```
+
+## `kalshitools plugins update`
+
+Update installed plugins.
+
+```
+USAGE
+  $ kalshitools plugins update [-h] [-v]
+
+FLAGS
+  -h, --help     Show CLI help.
+  -v, --verbose
+
+DESCRIPTION
+  Update installed plugins.
+```
+
+_See code: [@oclif/plugin-plugins](https://github.com/oclif/plugin-plugins/blob/v5.4.56/src/commands/plugins/update.ts)_
+
+## `kalshitools portfolio balance`
+
+View account balance
+
+```
+USAGE
+  $ kalshitools portfolio balance [--json]
+
+FLAGS
+  --json  Output in JSON format
+
+DESCRIPTION
+  View account balance
+
+EXAMPLES
+  $ kalshitools portfolio balance
+
+  $ kalshitools portfolio balance --json
+```
+
+_See code: [src/commands/portfolio/balance.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/portfolio/balance.ts)_
+
+## `kalshitools portfolio fills`
+
+View trade history (fills)
+
+```
+USAGE
+  $ kalshitools portfolio fills [--json] [--ticker <value>] [--limit <value>]
+
+FLAGS
+  --json            Output in JSON format
+  --limit=<value>   [default: 50] Maximum number of fills to return
+  --ticker=<value>  Filter by ticker
+
+DESCRIPTION
+  View trade history (fills)
+
+EXAMPLES
+  $ kalshitools portfolio fills
+
+  $ kalshitools portfolio fills --ticker TICKER
+
+  $ kalshitools portfolio fills --limit 20
+
+  $ kalshitools portfolio fills --json
+```
+
+_See code: [src/commands/portfolio/fills.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/portfolio/fills.ts)_
+
+## `kalshitools portfolio positions`
+
+View current positions with P&L
+
+```
+USAGE
+  $ kalshitools portfolio positions [--json]
+
+FLAGS
+  --json  Output in JSON format
+
+DESCRIPTION
+  View current positions with P&L
+
+EXAMPLES
+  $ kalshitools portfolio positions
+
+  $ kalshitools portfolio positions --json
+```
+
+_See code: [src/commands/portfolio/positions.ts](https://github.com/kalshitools/kalshitools/blob/v1.0.0/src/commands/portfolio/positions.ts)_
+<!-- commandsstop -->

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --disable-warning=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/config/init.d.ts

@@ -0,0 +1,13 @@
+import { BaseCommand } from '../../lib/base-command.js';
+export default class ConfigInit extends BaseCommand {
+    static description: string;
+    static examples: string[];
+    static flags: {
+        env: import("@oclif/core/interfaces").OptionFlag<string, import("@oclif/core/interfaces").CustomOptions>;
+        keyId: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        privateKeyPath: import("@oclif/core/interfaces").OptionFlag<string | undefined, import("@oclif/core/interfaces").CustomOptions>;
+        json: import("@oclif/core/interfaces").BooleanFlag<boolean>;
+    };
+    run(): Promise<void>;
+    private promptForInput;
+}