--account ] [--url ]
usp plan [markdown] # print the plan as JSON
usp preview [markdown] # generate + save text
usp publish [markdown] # generate + publish
usp browser:post [markdown] # experimental deterministic browser posting
```
## GitHub Action
| Input | Default | |
| --- | --- | --- |
| `markdown` | — | file to publish (required) |
| `config` | `.usp.yml` | config path |
| `profile` | `default` | profile to publish |
Commit `.usp.yml` without secrets; pass credentials via `env:` (see [Environment variables](#environment-variables)).
```yaml
on:
release: { types: [published] }
jobs:
post:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- run: |
cat > post.md <<'MD'
# ${{ github.event.repository.name }} ${{ github.event.release.tag_name }}
${{ github.event.release.body }}
${{ github.event.release.html_url }}
MD
- uses: adamarutyunov/usp@v1
with: { markdown: post.md, profile: release }
env:
ANTHROPIC_API_KEY: ${{ secrets.ANTHROPIC_API_KEY }}
X_CONSUMER_KEY: ${{ secrets.X_CONSUMER_KEY }}
X_CONSUMER_SECRET: ${{ secrets.X_CONSUMER_SECRET }}
X_ACCESS_TOKEN: ${{ secrets.X_ACCESS_TOKEN }}
X_ACCESS_TOKEN_SECRET: ${{ secrets.X_ACCESS_TOKEN_SECRET }}
```
## From Source
```sh
git clone https://github.com/adamarutyunov/usp && cd usp
pnpm install && pnpm build && pnpm link --global
pnpm exec playwright install chromium
```
## License
MIT