jump-start-tools

CLI tool for the jump-start template system: A shortcut to your favorite code.

New to jump-start? Start with the jump-start-template repository to understand the system and set up your first template collection.

Coming from 0.1.X? See how to upgrade in UPGRADE.md.

Installation

cargo install jump-start
jump-start --help

Configuration

jump-start config

This prints the path to your config.json file. Edit it to add your starter instances:

Single Instance

{
  "instances": [
    {
      "name": "my-templates",
      "path": "/home/user/my-jump-start-templates",
      "default": true
    }
  ]
}

Multiple Instances

{
  "instances": [
    {
      "name": "work",
      "path": "/home/user/work-templates",
      "default": true
    },
    {
      "name": "personal",
      "path": "/home/user/personal-templates",
      "default": false
    }
  ]
}

Usage

Common Workflows

Local starters

# Use a specific starter
jump-start use frontend/react-app

# Use with custom output directory
jump-start use frontend/react-app --out my-new-project

# Search through local starters
jump-start find react

Remote starters

# Use starter from GitHub repository
jump-start use @kevinschaul/react-d3/LineChart

Command Reference

`jump-start use`

Use a starter

Usage: jump-start use <STARTER_IDENTIFIER> [DEST]

Arguments:
  <STARTER_IDENTIFIER>  The starter to use.
                        For local starters: group/starter-name
                            e.g. react-d3/LineChart
                        For remote starters: @username/group/starter-name or @username/repo/group/starter-path
                            e.g. @kevinschaul/react-d3/LineChart
  [DEST]                Optional destination directory

Options:
  -h, --help  Print help

`jump-start config`

Print path to config file

Usage: jump-start config

Options:
  -h, --help  Print help

`jump-start storybook`

Storybook commands

Usage: jump-start storybook <COMMAND>

Commands:
  dev   Start Storybook development server
  prod  Build Storybook for production
  help  Print this message or the help of the given subcommand(s)

Options:
  -h, --help  Print help

Development Server

Start Storybook development server

Usage: jump-start storybook dev [OPTIONS]

Options:
      --instance-path <INSTANCE_PATH>  Path to the instance to operate on
  -p, --port <PORT>                    Port to run Storybook on [default: 6006]
  -h, --help                           Print help

Production Build

Build Storybook for production

Usage: jump-start storybook prod [OPTIONS]

Options:
      --instance-path <INSTANCE_PATH>  Path to the instance to operate on
  -o, --output <OUTPUT>                Output directory [default: storybook-static]
  -h, --help                           Print help

`jump-start find`

Find a starter

Usage: jump-start find [OPTIONS] <SEARCH_TERM>

Arguments:
  <SEARCH_TERM>  Search term to find starters (searches names and content)

Options:
      --json  Output results as JSON
  -h, --help  Print help

Search Term Examples:

react - Find all starters containing "react"
frontend - Find starters in the frontend group
python - Find Python-related templates

`jump-start update-readme`

Update readme

Usage: jump-start update-readme [OPTIONS]

Options:
      --instance-path <INSTANCE_PATH>  Path to the instance to operate on
  -h, --help                           Print help

Neovim plugin

./nvim provides a Telescope extension to search and use jump-start starters.

To install with lazy.nvim:

{ dir = "~/dev/jump-start-tools/nvim" },

You will have a new Telescope picker. Run it with:

:Telescope jump_start find

But you problably want to set up your own mappings. Here is mine:

["<Leader>fj"] = {
  function() require("telescope").extensions.jump_start.find() end,
  desc = "Find jump-starter",
},

Development

Build and test:

make build
make test

Install locally:

cargo install --path cli

Release a new version:

make release

jump-start 0.2.3