runme

command module
v0.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 16, 2022 License: Apache-2.0 Imports: 3 Imported by: 0

README

runme

Discover and run code snippets directly from your README.md or other markdowns (defaults to local README.md).

runme makes a best effort approach to extracts all code snippets defined in code blocks and allowing to explore and execute them. runme is currently in early alpha.

You can execute commands from a different directory using a --chdir flag. To select a different file than README.md, use --filename.

Installation

The easiest way on MacOS is to use Homebrew:

$ brew update

Install runme:

$ brew install stateful/tap/runme

Alternatively, check out runme's releases and select a binary for your operating system.

If you have Go developer tools installed, you can install it with go install:

$ go install github.com/stateful/runme@latest

Commands

Help
$ runme help
List
$ runme list
Print
$ runme print hello-world
Run selected command, Example: Update brew
$ runme run update-brew
Example Command
echo "hello world"

Contributing & Feedback

Let us know what you think via GitHub issues or submit a PR. Join the conversation on Discord. We're looking forward to hear from you.

LICENCE

Apache License, Version 2.0

Documentation

The Go Gopher

There is no documentation for this package.

Directories

Path Synopsis
cmd
internal
cmd

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL