textusm.cli

0.14.9 • Public • Published

TextUSM CLI

MIT License

Generate a User Story Mapping from indented text.

CLI for TextUSM.

Installation

$ npm i -g textusm.cli

Examples

$ cat input.txt | textusm -o output.svg
$ textusm -i input.txt -o output.svg
$ textusm -i input.txt -o output.svg
$ textusm -i input.txt -o output.png
$ textusm -i input.txt -o output.pdf
$ textusm -i input.txt -o output.html
$ textusm -i input.txt -o output.html -d businessmodelcanvas

Options

Usage: textusm [options]

Options:
  -V, --version                    output the version number
  -c, --configFile [configFile]    Config file.
  -i, --input <input>              Input text file.
  -w, --width <width>              Width of the page. Optional. Default: 1024.
  -p, --cdp <chromeUrl>            connect to running chrome instance for better performance. Optional.
  -H, --height <height>            Height of the page. Optional. Default: 1024.
  -o, --output [output]            Output file. It should be svg, png, pdf or html.
  -d, --diagramType [diagramType]  Diagram type. It should be one of user_story_map, opportunity_canvas,
                                   business_model_canvas, 4ls, start_stop_continue, kpt, userpersona,
                                   mind_map, empathy_map, table, site_map, gantt_chart, impact_map,
                                   er_diagram, kanban, sequence_diagram, free_form
  -h, --help                       display help for command

Example Input file

User Story Map

# Comment
TextUSM
    Online tool for making user story mapping
        Press Tab to indent lines
        Press Shift + Tab to unindent lines: Note

image

Business Model Canvas

👥 Key Partners
    Key Partners
📊 Customer Segments
    Customer Segments
🎁 Value Proposition
    Value Proposition
✅ Key Activities
    Key Activities
🚚 Channels
    Channels
💰 Revenue Streams
    Revenue Streams
🏷️ Cost Structure
    Cost Structure
💪 Key Resources
    Key Resources
💙 Customer Relationships
    Customer Relationships

image

Opportunity Canvas

Problems
    Problems
Solution Ideas
    Solution Ideas
Users and Customers
    Users and Customers
Solutions Today
    Solutions Today
Business Challenges
    Business Challenges
How will Users use Solution?
    How will Users use Solution?
User Metrics
    User Metrics
Adoption Strategy
    Adoption Strategy
Business Benefits and Metrics
    Business Benefits and Metrics
Budget
    Budget

image

4Ls Retrospective

Liked
  liked
Learned
  learned
Lacked
  lacked
Longed For
  longedFor

image

Start, Stop, Continue Retrospective

Start
  Start
Stop
  stop
Continue
  continue

image

KPT Retrospective

Keep
  keep
Problem
  problem
Try
  try

image

MindMap

TextUSM
    WORK QUICKLY
        Draw diagrams without leaving the keyboard.
    SAVE TIME
        Instantly visualize your ideas.
    EXPORT TO IMAGES
        Images can be exported as png or svg.
    SHARING
        Share your diagrams online with your colleagues.

image

Empathy Map

https://app.textusm.com/images/logo.svg
SAYS
THINKS
DOES
FEELS

image

Table

Column1
    Column2
    Column3
    Column4
    Column5
    Column6
    Column7
Row1
    Column1
    Column2
    Column3
    Column4
    Column5
    Column6
Row2
    Column1
    Column2
    Column3
    Column4
    Column5
    Column6

image

Site Map

Home
    Download
        TextUSM
        Help you draw user story map using indented text.
        WORK QUICKLY
        SAVE TIME
    Privacy Policy
        Test
    Terms
        Test
    Contacts
        harehare1110@gmail.com

image

Gantt Chart

2019-12-26,2020-01-31: title
    subtitle1
        2019-12-26, 2019-12-31: task1
        2019-12-31, 2020-01-04: task2

image

Impact Map

TextUSM
    WORK QUICKLY
        Draw diagrams without leaving the keyboard.
    SAVE TIME
        Instantly visualize your ideas.
    EXPORT TO IMAGES
        Images can be exported as png or svg.
    SHARING
        Share your diagrams online with your colleagues.

image

ER Diagram

relations
    DiagramDetail - Diagram
    # One To Many
    User < Comment
    Diagram < Comment
    User < Diagram
    User < DiagramUser
    Diagram < DiagramUser
tables
    Diagram
        diagram_id int pk
        name varchar(255) not null
        type enum(userstorymap,mindmap)
        is_bookmark boolean default false
    DiagramDetail
        diagram_id int pk
        is_bookmark boolean default false
        is_public boolean default false
    Comment
        comment_id int pk
        comment text not null
        diagram_id int not null
        user_id int not null
    User
        user_id int pk
        name varchar(255)
    DiagramUser
        diagram_id int pk
        user_id int pk

image

Kanban

TODO
    task1
    task1
DOING
    task2
    task2
DONE
    task3
    task3

image

Sequence Diagram

participant
    object1
    object2
    object3
object1 -> object2
    Sync Message
object1 ->> object2
    Async Message
object2 --> object1
    Reply Message
o-> object1
    Found Message
object1 ->o
    Stop Message
loop
    loop message
        object1 -> object2
            Sync Message
        object1 ->> object2
            Async Message
Par
    par message1
        object2 -> object3
            Sync Message
    par message2
        object1 -> object2
            Sync Message

image

Keyboard Layout

r4
    Esc
    !,1
    @,2
    {sharp},3
    $,4
    %,5
    ^,6
    &,7
    *,8
    (,9
    ),0
    _,-
    =,+
    |,\\
    ~,{backquote}
r4
    Tab,,1.5u
    Q
    W
    E
    R
    T
    Y
    U
    I
    O
    P
    {,[
    },]
    Backspace,,1.5u
r3
    Control,,1.75u
    A
    S
    D
    F
    G
    H
    J
    K
    L
    :,;
    \",'
    Enter,,2.25u
r2
    Shift,,2.25u
    Z
    X
    C
    V
    B
    N
    M
    <,{comma}
    >,.
    ?,/
    Shift,,1.75u
    Fn
r1
    1.25u
    Opt
    Alt,,1.75u
    ,,7u
    Alt,,1.75u
    Opt
    1.25u

image

Installation

Example JSON configuration file

{
  "font": "Open Sans",
  "size": {
    "width": 140,
    "height": 65
  },
  "backgroundColor": "#F5F5F6",
  "color": {
    "activity": {
      "color": "#000000",
      "backgroundColor": "#FFFFFF"
    },
    "task": {
      "color": "#FFFFFF",
      "backgroundColor": "#3E9BCD"
    },
    "story": {
      "color": "#000000",
      "backgroundColor": "#FFFFFF"
    },
    "line": "#434343",
    "label": "#8C9FAE",
    "text": "#111111"
  },
  "scale": 1.0
}

Package Sidebar

Install

npm i textusm.cli

Weekly Downloads

6

Version

0.14.9

License

MIT

Unpacked Size

591 kB

Total Files

5

Last publish

Collaborators

  • harehare