@mtreeai/msapling-cli 2.3.6-beta.1

package/LICENSE

@@ -0,0 +1,24 @@
+PROPRIETARY LICENSE
+
+Copyright (c) 2026 MTreeAI Inc. All rights reserved.
+
+This software and associated documentation files (the "Software") are the
+proprietary, confidential property of MTreeAI Inc. ("MTreeAI"). Unauthorized
+copying, modification, distribution, public display, public performance, or
+creation of derivative works of the Software, in whole or in part, by any
+means, is strictly prohibited.
+
+No license, express or implied, is granted by this notice. Use of the Software
+is permitted only under the terms of a separate written agreement with MTreeAI
+or under the terms of MTreeAI's published Terms of Service at
+https://msapling.com/policy. Use of the Software constitutes acceptance of those
+terms.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE, AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY ARISING FROM, OUT OF, OR IN CONNECTION WITH THE SOFTWARE OR THE USE
+OR OTHER DEALINGS IN THE SOFTWARE.
+
+For licensing inquiries: https://msapling.com/support

package/README.md

@@ -0,0 +1,168 @@
+# MSapling CLI
+
+MSapling CLI is the React/TypeScript terminal client for the MSapling backend.
+
+## Install
+
+Install the MSapling CLI globally via npm:
+
+```bash
+npm install -g @msapling/cli
+```
+
+**Requirements:** Node.js 18 or higher.
+
+**Note:** Version 2.3.3+ is the first npm-installable release with email/password login support. See [@msapling/cli on npm](https://www.npmjs.com/package/@msapling/cli) for the latest version.
+
+## First Run
+
+Start the interactive REPL:
+
+```bash
+msapling
+```
+
+Inside the REPL, authenticate using one of these methods:
+
+```
+/login your@email.com    # Email + password login (with optional 2FA)
+/login github            # GitHub device flow (opens browser)
+/login <token>           # Paste an API token from msapling.com Settings
+```
+
+All methods store the token via the OS keychain (Windows DPAPI, macOS Keychain, or Linux libsecret).
+
+Once logged in, start chatting:
+
+```
+/chat hello
+```
+
+## CLI Subcommands (argv)
+
+These are passed directly on the command line before the REPL starts:
+
+| Command | Description |
+|---------|-------------|
+| *(none)* | Start interactive REPL |
+| `--compact` | Start REPL in compact mode (thin separators, no footer) |
+| `mcp serve` | Run as MCP stdio server (Claude Code / Cursor / Windsurf integration) |
+| `--version` | Print version and exit |
+| `--help` | Print usage and exit |
+
+## Inside the REPL — Slash Commands
+
+Once the REPL is running, type `/help` to see all available slash commands. Common ones:
+
+| Slash Command | Description |
+|---------------|-------------|
+| `/login your@email.com` | Sign in with email + password (recommended for end users) |
+| `/login github` | GitHub device flow (for developers) |
+| `/login <token>` | Paste an API token from Settings → API Keys |
+| `/logout` | Clear stored token |
+| `/chat <message>` | Send a message and stream a response |
+| `/swarm <prompt>` | Run parallel agent swarms |
+| `/models` | List available models |
+| `/cost` | Show usage and billing data |
+| `/config` | View and edit configuration |
+| `/help` | Show all slash-command help |
+
+> **Note:** `chat`, `login`, `models`, `cost`, `swarm`, and `config` are REPL slash-commands (prefixed with `/`), not top-level argv subcommands. Run `msapling --help` to see the argv interface.
+
+See `packages/cli/src/commands/index.ts` for the canonical slash-command list.
+
+---
+
+
+
+The CLI is not meant to be a large standalone agent runtime. MSapling's backend is the source of truth for auth, projects, chats, model routing, usage, billing, MDrive, locks, and audit data. The website, mobile app, and CLI should all show and modify the same backend state.
+
+## Product Direction
+
+MSapling started as a multi-chat browser workspace: multiple AI chats, many model choices, BYOK, OpenRouter, and Ollama support in one UI.
+
+The mobile app extends that shared workspace to one-chat-at-a-time usage and phone-first workflows such as sending a photo into a chat.
+
+The CLI brings the same backend workspace to the terminal. It should be fast, low-resource, and useful without duplicating the backend.
+
+## Architecture
+
+```text
+Website     \
+Mobile App   ->  MSapling Backend  ->  chats, projects, usage, billing, MDrive, locks
+CLI         /
+```
+
+The CLI should:
+
+- authenticate with the backend
+- read projects and chats from the backend
+- stream chat responses from `/api/chat/message`
+- display backend usage and quota data
+- respect backend stream locks
+- use backend MDrive/edit proposal flows
+- keep local terminal work lightweight
+
+The CLI should not:
+
+- invent separate chat state
+- compute billing locally
+- simulate MDrive state
+- bypass backend locks
+- duplicate backend orchestration unless there is a clear reason
+
+## Current State
+
+This directory is a Bun monorepo scaffold using React and Ink.
+
+Port useful behavior selectively. Do not port backend-like responsibilities.
+
+Known current gaps:
+
+- workspace package manifests are missing
+- the Ink input loop is incomplete
+- `Agent` is referenced but not implemented
+- MDrive logic is simulated locally
+- backend route contracts need to be aligned
+- tests and build are not yet passing
+
+## Near-Term Goal
+
+Build a stable thin client:
+
+1. Login and secure token storage.
+2. Fetch backend project overview.
+3. Open or create chats.
+4. Stream backend chat responses.
+5. Show shared chat history across website, app, and CLI.
+6. Handle lock, quota, and auth errors clearly.
+7. Add `/doctor`.
+
+## Commands
+
+```bash
+bun install
+bun run build
+bun test
+bun run start
+```
+
+These commands are target commands. They may not pass until the workspace manifests and dependencies are completed.
+
+## Environment
+
+```bash
+MSAPLING_API_URL=https://api.msapling.com
+```
+
+For local development, point `MSAPLING_API_URL` at the local backend.
+
+## Design Principle
+
+Keep the CLI small.
+
+The backend should do the heavy work. The CLI should make that backend fast and comfortable from a terminal.
+
+---
+
+**Full architecture overview:** see ARCHITECTURE.md (when published) or `packages/core/README.md`.