Skip to content

Commit 4b774d8

Browse files
committed
Update README for CLI launch
1 parent 4c6f97a commit 4b774d8

2 files changed

Lines changed: 7 additions & 11 deletions

File tree

README.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -53,12 +53,15 @@ sunpeak is an npm package consisting of:
5353
1. Runtime APIs - Strongly typed, multi-platform APIs for interacting with the ChatGPT runtime, architected to support future platforms (Gemini, Claude).
5454
2. ChatGPT simulator - React component replicating ChatGPT's runtime.
5555
3. MCP server - Mock data MCP server for testing local Resources in the real ChatGPT.
56-
2. **The `sunpeak` framework** (`./template`). An end-to-end framework for ChatGPT Apps, from quickstart to shipped. This templated npm package includes:
57-
1. Project scaffold - Complete development setup with build, test, and mcp tooling.
56+
2. **The `sunpeak` framework** (`./template`). Next.js for ChatGPT Apps. This templated npm package includes:
57+
1. Project scaffold - Complete development setup with build, test, and mcp tooling, including the sunpeak library.
5858
2. UI components - Production-ready components following ChatGPT design guidelines and using OpenAI apps-sdk-ui React components.
59-
3. CLI utility (`./bin`) - Commands for working with the sunpeak framework.
59+
3. **The `sunpeak` CLI** (`./bin`). Commands for managing ChatGPT Apps. Includes a client for the sunpeak Resource Repository (ECR for ChatGPT Apps). The repository helps you & your CI/CD decouple your App from your client-agnostic MCP server:
60+
1. Tag your app builds with version numbers and environment names (like `v1.0.0` and `prod`)
61+
2. `push` built Apps to a central location
62+
3. `pull` built Apps to be run in different environments
6063

61-
Note that the `sunpeak` library can be used without the framework.
64+
Note that each `sunpeak` component can be used in isolation if preferred, though the most seamless experience combines all 3.
6265

6366
## Example Component
6467

@@ -81,12 +84,6 @@ export function MCPResource() {
8184
}
8285
```
8386

84-
## Contributing
85-
86-
We welcome your contributions!
87-
88-
For development quickstart on this package, see [DEVELOPMENT.md](./DEVELOPMENT.md).
89-
9087
## Resources
9188

9289
- [ChatGPT Apps SDK Design Guidelines](https://developers.openai.com/apps-sdk/concepts/design-guidelines)

bin/commands/deploy.mjs

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,4 @@
11
#!/usr/bin/env node
2-
import { join } from 'path';
32
import { push, findResources } from './push.mjs';
43

54
/**

0 commit comments

Comments
 (0)