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
11 changes: 11 additions & 0 deletions .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,18 @@ jobs:

- run: pnpm build

- name: Check if version already published
id: version-check
run: |
LOCAL_VERSION=$(node -p "require('./package.json').version")
if npm view @recoupable/cli@$LOCAL_VERSION version 2>/dev/null; then
echo "published=true" >> $GITHUB_OUTPUT
else
echo "published=false" >> $GITHUB_OUTPUT
fi

- name: Publish to npm
if: steps.version-check.outputs.published == 'false'
run: pnpm publish --no-git-checks
env:
NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
78 changes: 78 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
# @recoupable/cli

Command-line interface for the [Recoup](https://recoupable.com) platform.

## Quick Start

### Install

```bash
npm install -g @recoupable/cli
```

### Authenticate

Set your API key as an environment variable:

```bash
export RECOUP_API_KEY=your-api-key
```

### Verify

```bash
recoup whoami
```

## Commands

### Account

```bash
recoup whoami # Show your account ID
recoup whoami --json # Output as JSON
```

### Artists

```bash
recoup artists list # List your artists
recoup artists list --json
```

### Chats

```bash
recoup chats list # List your chats
recoup chats create --name "Topic" # Create a new chat
recoup chats create --artist <id> # Create a chat with an artist
```

### Sandboxes

```bash
recoup sandboxes list # List your sandboxes
recoup sandboxes create # Create a new sandbox
recoup sandboxes create --command "ls -la" # Create and run a command
```

### Organizations

```bash
recoup orgs list # List your organizations
```

### Global Flags

All commands support `--json` for machine-readable JSON output.

## Configuration

| Variable | Required | Description |
|----------|----------|-------------|
| `RECOUP_API_KEY` | Yes | Your Recoup API key |
| `RECOUP_API_URL` | No | API base URL (default: `https://recoup-api.vercel.app`) |

## License

MIT
3 changes: 2 additions & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
"recoup": "./dist/bin.cjs"
},
"files": [
"dist"
"dist",
"README.md"
],
"scripts": {
"build": "tsup",
Expand Down