open-index/open-npm huggingface dataset:
npm package: @movable/sc-scripts
Description: Simple CLI for Shortcut project management
Latest version: 1.0.0

# sc-scripts

Simple CLI for Shortcut project management.

## Installation

### Using npm
```bash
npm install -g @movable/sc-scripts
```

### Using Yarn
```bash
yarn global add @movable/sc-scripts
```

### Using Volta
```bash
volta install @movable/sc-scripts
```

### From source
```bash
git clone https://github.com/movableink/sc-scripts.git
cd sc-scripts
yarn install
yarn link
```

## Setup

Before using the CLI, you need to authenticate with your Shortcut API token:

```bash
sc auth
```

You'll be prompted to enter your Shortcut API token. You can find your API token at:
https://app.shortcut.com/settings/account/api-tokens

The token is stored securely in `~/.config/sc/auth` with read-only permissions for your user.

## Usage

### List teams/groups
Show all teams with their IDs and associated workflows:
```bash
sc teams
# or
sc groups
```

### List projects
Show all projects with their IDs:
```bash
sc projects
```

### List workflows
Show all workflows with their IDs:
```bash
sc workflows
```

### Search stories
Search for stories by keyword:
```bash
sc stories "search term"
```

## For LLM Users

Add the following to your project's CLAUDE.md file to help Claude understand how to use Shortcut in your workflow:

```markdown
## Shortcut Integration

This project uses the `sc` CLI tool for Shortcut integration. Available commands:

- `sc stories "keyword"` - Search for stories related to a keyword
- `sc teams` - List all teams with their workflow IDs
- `sc projects` - List all projects
- `sc workflows` - List all workflows

For anything else, use the Shortcut MCP server if available.
```

## Development

### Prerequisites
- Node.js >= 20
- Yarn

### Setup
```bash
yarn install
```

### Run locally
```bash
./sc.js [command]
# or
node sc.js [command]
```

### Install locally for development
```bash
yarn link
```

## License

MIT