# salesforce-story-manager

> Salesforce Org Repo Git CLI Wrapper

Latest version **1.1.14** (published 2023-01-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install salesforce-story-manager
pnpm add salesforce-story-manager
yarn add salesforce-story-manager
bun add salesforce-story-manager
```

Provides the command `ssm`.

## Health

**Score 20/100 (F)** — status: abandoned.

Positive: esm support; no vulnerabilities.

Warnings: low downloads; no types.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.1.14 |
| Published | 2023-01-23 |
| First published | 2023-01-16 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | ESM + CommonJS |
| Dependencies | 3 |
| Unpacked size | 63.3 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | ottobotowner@gmail.com |
| Maintainers | ottobot-owner |

## Links

- npm: https://www.npmjs.com/package/salesforce-story-manager
- npm.io page: https://npm.io/package/salesforce-story-manager

## Dependencies (3)

- [axios](https://npm.io/package/axios.md) ^1.2.3
- [inquirer](https://npm.io/package/inquirer.md) ^9.1.4
- [rc-parser](https://npm.io/package/rc-parser.md) ^1.0.2

## Recent versions

- 1.1.14 (latest) — 2023-01-23
- 1.1.13 — 2023-01-23
- 1.1.12 — 2023-01-23
- 1.1.11 — 2023-01-20
- 1.1.10 — 2023-01-19
- 1.0.10 — 2023-01-18
- 1.0.9 — 2023-01-18
- 1.0.8 — 2023-01-18
- 1.0.7 — 2023-01-18
- 1.0.6 — 2023-01-18
- 1.0.5 — 2023-01-18
- 1.0.4 — 2023-01-16
- 1.0.3 — 2023-01-16
- 1.0.2 — 2023-01-16
- 1.0.1 — 2023-01-16

## README

<h1 align="center" style="font-weight: 400"> Help track metadata file changes by user stoy for Salesforce Developers </h2>

<br/>

### Steps to Use CLI

* An existing sfdx project with valid manifest/package.json
* The sfdx project does not have source control initiated
* SFDX CLI installed
* Use the below commands to install and use this CLI
* Install this package globally or from the project root directory

### Install local

`$ npm i salesforce-story-manager`

### Run local

`$ npx ssm`

### Install global

`$ npm i -g salesforce-story-manager`

### Run global

`$ ssm`

### This is a CLI that allows you to

* easily create a branch for each user story
* organize user stories (branches) by sprint
* create branches from main branch at Head or Initial Commit
* automatically stash staged and unstaged changes when switching between stories (branches)
* list all changes made in the org by your user since last commit
* retrieve changes from the org by manifest for each story
* commit staged changes to the user story
* list files committed against the branch from force-app
* list git log for the branch
* manually stash/retrieve changes on each story

<br/>

# Story Organization

## Create / Select a Sprint

* Create sprint
* Select sprint to go to Sprint Stories

## Create / Select a Story

* Create story

  * From initial commit

  * From latest commit on main branch

  * From most updated org data pulled by manifest

* Select story to go to Story Menu

# Story Management

## Remove Story

* Permanantly remove stories (branches)
* Validate removal with two step deletion approval

## Assign Story

* Reassign stories to other sprints or Uncategorized Stories

## Retrieve Org Changes

* Pull latest org changes based on the manifest/package.json file

## List My Org Changes

* Provide an org username in your configuration file
* This feature queries the Setup Audit Trail object
* The query will run for all changes by your user since the last commit for that story

## List Committed Files

* An aggregated list of all files committed to the story branch from the force-app directory

## Show Commit Log

* View a colorized printout of the commit log for that story

## Stash / Retrieve Changes

* Stash changes (will stash staged and unstaged) by label you create
* Stashes are kept by branch so you only see and retrieve stashes for that story
* Retrieve stored stashes for a branch
* (All staged and unstaged changes are always automatically stashed and restored when moving between stories)

## Commit Changes

* Commit changes that you stage using the Git GUI or CLI

# Open Source

## Issues and Feedback Options to come in future releases

---
_Source: https://npm.io/package/salesforce-story-manager · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
