Skip to content

update readme to make cli installation optional #30

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pjcdawkins merged 3 commits into from
May 17, 2026
Merged

update readme to make cli installation optional #30

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0316e82
update readme to make cli installation optional
ganeshdipdumbare May 4, 2026
dd6d820
Potential fix for pull request finding
ganeshdipdumbare May 4, 2026
8ab68b8
Merge branch 'main' into update-readme-for-cli
ganeshdipdumbare May 5, 2026
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
16 changes: 9 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,10 +15,14 @@ Upsun plugin for AI coding agents and IDEs. Manage [Upsun](https://upsun.com) pr

### Prerequisites

1. **Upsun CLI** v5.6.0 or higher installed and authenticated

1. **AI coding agent or IDE** – e.g. [Claude Code](https://claude.ai/code), Cursor, or other MCP-compatible tools

2. **Upsun CLI** v5.6.0 or higher *(optional but recommended)*

The skill can be used without the CLI, but automatic fallback to the MCP server only works when the MCP configuration in `plugins/upsun/.mcp.json` is installed. For `skills.sh` or other skill-only installs, install the CLI for operational commands unless you separately configure MCP. Install the CLI for full functionality (deploys, SSH, tunnels, local development):

```bash
# Install Upsun CLI (if not already installed)
# Install Upsun CLI
curl -fsSL https://raw.githubusercontent.com/upsun/cli/main/installer.sh | bash

# Or via brew
Expand All @@ -28,8 +32,6 @@ Upsun plugin for AI coding agents and IDEs. Manage [Upsun](https://upsun.com) pr
upsun login
```

2. **AI coding agent or IDE** – e.g. [Claude Code](https://claude.ai/code), Cursor, or other MCP-compatible tools

### Claude Code

```bash
Expand Down Expand Up @@ -188,9 +190,9 @@ This structure means the plugin is self-contained and reusable — any agent tha

### Requirements

- Upsun CLI v5.6.0 or higher
- AI coding agent or IDE (Claude Code, Cursor, etc.)
- Authenticated Upsun account
- Upsun CLI v5.6.0 or higher *(optional — the skill falls back to the MCP server when CLI is not available)*
Comment thread
ganeshdipdumbare marked this conversation as resolved.

### License

Expand All @@ -206,5 +208,5 @@ This project is licensed under the MIT - see the [LICENSE](LICENSE) file for det
### Acknowledgments

- Upsun plugin for AI coding agents and the [Upsun](https://upsun.com) Platform-as-a-Service
- Uses Upsun CLI v5.6.0+ command structure
- Upsun CLI v5.6.0+ command structure used where available

Loading