Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions docs/APIs-and-SDKs/CLI-Documentation/authentication.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ sidebar_position: 2

# Authentication

The CLI stores credentials in your OS keychain (via keytar) and configuration in `~/.config/absmartly/config.yaml`. On headless systems without a keychain service, credentials fall back to `~/.config/absmartly/credentials.json` (chmod 600).
The CLI stores credentials in your OS keychain (via keytar) and configuration in `~/.config/absmartly/config.yaml`. On headless systems without a keychain service, credentials fall back to a local `~/.config/absmartly/credentials.json` file.

Two authentication methods are supported.

Expand All @@ -14,8 +14,8 @@ Two authentication methods are supported.
# Login with API key
abs auth login --api-key YOUR_KEY --endpoint https://your-instance.absmartly.com/v1

# Login with a named profile
abs auth login --api-key YOUR_KEY --endpoint https://staging.absmartly.com/v1 --profile staging
# Login with a named profile (e.g. for a read-only key)
abs auth login --api-key YOUR_READONLY_KEY --endpoint https://your-instance.absmartly.com/v1 --profile readonly
```

## OAuth authentication
Expand Down Expand Up @@ -49,7 +49,7 @@ The `-k` flag disables TLS certificate verification. Only use in trusted develop
# Check authentication status
abs auth status
abs auth status --show-key # reveal full API key
abs auth status --profile staging
abs auth status --profile readonly

# Show current authenticated user
abs auth whoami
Expand All @@ -71,7 +71,7 @@ abs auth reset-my-password

# Logout
abs auth logout
abs auth logout --profile staging
abs auth logout --profile readonly
```

You can also override credentials per-command with global options:
Expand Down
8 changes: 4 additions & 4 deletions docs/APIs-and-SDKs/CLI-Documentation/configuration.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -39,7 +39,7 @@ abs config unset output

# Manage profiles
abs config profiles list
abs config profiles use staging
abs config profiles use readonly
abs config profiles delete old-profile
```

Expand All @@ -57,12 +57,12 @@ profiles:
endpoint: https://ctl.absmartly.io/v1
application: my-app
environment: production
staging:
readonly:
api:
endpoint: https://staging.absmartly.com/v1
endpoint: https://your-instance.absmartly.com/v1
expctld:
endpoint: https://ctl.absmartly.io/v1
environment: staging
environment: production
```

### Environment variables
Expand Down
16 changes: 3 additions & 13 deletions docs/APIs-and-SDKs/CLI-Documentation/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,18 +13,6 @@ The CLI wraps the same Platform API used by the web console, so anything you can
This project is experimental. The core architecture is settled, but the API surface may change between releases.
:::

| Area | Status |
|---|---|
| Experiment commands (list, get, create, update, start, stop, restart, clone, bulk) | Stable — well tested |
| Metric results, CI bars, segment breakdowns | Stable |
| Template round-trip (export → edit → create/update) | Stable |
| Core layer (`@absmartly/cli/core/*`) for programmatic use | Stable — 444 unit tests |
| Admin commands (tags, roles, teams, users, webhooks, etc.) | Mostly stable — less battle-tested |
| OAuth authentication | Working — tested against live API |
| Interactive editor (`--interactive` / `-i` flag) | Experimental — known issues, not production-ready |
| Shell completions | Working — may have gaps |
| Unix pipe composition | Stable |

## Installation

```bash
Expand All @@ -41,7 +29,9 @@ abs setup

# Non-interactive setup
abs setup --api-key YOUR_KEY --endpoint https://your-instance.absmartly.com/v1
abs setup --api-key YOUR_KEY --endpoint https://staging.absmartly.com/v1 --profile staging

# Non-interactive setup with a named profile (e.g. for a read-only key)
abs setup --api-key YOUR_READONLY_KEY --endpoint https://your-instance.absmartly.com/v1 --profile readonly

# Or authenticate manually
abs auth login --api-key YOUR_API_KEY --endpoint https://your-instance.absmartly.com/v1
Expand Down
2 changes: 0 additions & 2 deletions docs/APIs-and-SDKs/MCP-Server/setup.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -28,8 +28,6 @@ export const CursorInstallLink = () => (
</BrowserOnly>
);

# Setup

The ABsmartly MCP server can be added to any MCP-compatible client. This page
covers Claude Desktop, Claude Code, Cursor, Windsurf, VS Code (Copilot), Gemini
(CLI and Code Assist), ChatGPT and the DXT extension.
Expand Down
16 changes: 16 additions & 0 deletions docs/APIs-and-SDKs/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -84,6 +84,21 @@ Common starting points:
- [Usage Examples](/docs/APIs-and-SDKs/MCP-Server/usage-examples) — natural-language prompts that work today
- [Tools Reference](/docs/APIs-and-SDKs/MCP-Server/tools-reference) — the full surface: 230+ commands across 33 groups

### CLI

The [CLI](/docs/APIs-and-SDKs/CLI-Documentation/) is a command-line interface
for AI agents and humans to manage experiments, feature flags and A/B tests on
the ABsmartly platform. It wraps the same Platform API used by the web
console, so anything you can do in the dashboard, you can automate from a
terminal or a script.

Common starting points:

- [CLI Overview](/docs/APIs-and-SDKs/CLI-Documentation/) — installation and quick start
- [Authentication](/docs/APIs-and-SDKs/CLI-Documentation/authentication) — the full login flow
- [Experiments & Feature Flags](/docs/APIs-and-SDKs/CLI-Documentation/experiments-and-feature-flags) — the primary command reference
- [Programmatic Usage](/docs/APIs-and-SDKs/CLI-Documentation/programmatic-usage) — call the CLI's core layer directly from TypeScript/JavaScript

---

## Which one should I use?
Expand All @@ -95,6 +110,7 @@ Common starting points:
| Create, manage or query experiments programmatically | [Platform API](/docs/APIs-and-SDKs/Web-Console-API/backend) |
| Build automation, internal tools, or CI/CD integrations | [Platform API](/docs/APIs-and-SDKs/Web-Console-API/backend) |
| Drive ABsmartly from Claude, Cursor or another AI assistant | [MCP Server](/docs/APIs-and-SDKs/MCP-Server/overview) |
| Manage experiments from a terminal or CI/CD script | [CLI](/docs/APIs-and-SDKs/CLI-Documentation/) |
| Visually edit pages for an A/B test without writing code | [LaunchPad browser extension](/docs/web-console-docs/launchpad-browser-extension/getting-started) |
| Run experiments and configure the workspace from the UI | [Product Documentation](/docs/web-console-docs/overview) |

Expand Down
Loading