coi

package
v0.0.12 Latest Latest
Warning

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

Go to latest
Published: Mar 29, 2026 License: MIT Imports: 8 Imported by: 0

README

coi

Table of contents

Summary

A simple tool to generate document sections with provided command output.

Manual

$ notatio coi --help
NAME:
   notatio coi

USAGE:
   notatio coi [command options]

DESCRIPTION:
   Command output injector.

OPTIONS:
   --document value       markdown file path to be updated
   --header value         header to use for document lookups and generation
   --limiter-left value   string to use as a lookup limiter (default: "##")
   --limiter-right value  string to use as a lookup limiter - empty will use end of file as a limit (default: "##")
   --shell-name value     shell name to use in the output (default: "bash")
   --shell-prompt value   shell prompt prefix to use in the output (default: "$")
   --command value        command to execute (command execution is skipped if --output is also provided)
   --output value         output to inject
   --index value          index of a section to be used as a placeholder (useful if limiters refer to more than one section,
      0 = replace all) (default: 0)
   --help, -h  show help

Usage

Coming soon…

Documentation

Index

Constants

This section is empty.

Variables

View Source
var App = cli.Command{
	Name:         "coi",
	Aliases:      nil,
	Usage:        "",
	UsageText:    "",
	Description:  "Command output injector.",
	ArgsUsage:    "",
	Category:     "",
	BashComplete: nil,
	Before:       before,
	After:        nil,
	Action:       action,
	OnUsageError: nil,
	Flags: []cli.Flag{
		&cli.StringFlag{
			Name:     "document",
			Usage:    "markdown file path to be updated",
			Required: true,
		},
		&cli.StringFlag{
			Name:     "header",
			Usage:    "header to use for document lookups and generation",
			Required: true,
		},
		&cli.StringFlag{
			Name:  "limiter-left",
			Usage: "string to use as a lookup limiter",
			Value: "##",
		},
		&cli.StringFlag{
			Name:  "limiter-right",
			Usage: "string to use as a lookup limiter - empty will use end of file as a limit",
			Value: "##",
		},
		&cli.StringFlag{
			Name:  "shell-name",
			Usage: "shell name to use in the output",
			Value: "bash",
		},
		&cli.StringFlag{
			Name:  "shell-prompt",
			Usage: "shell prompt prefix to use in the output",
			Value: "$",
		},
		&cli.StringFlag{
			Name:  "command",
			Usage: "command to execute (command execution is skipped if --output is also provided)",
			Value: "",
		},
		&cli.StringFlag{
			Name:  "output",
			Usage: "output to inject",
			Value: "",
		},
		&cli.IntFlag{
			Name: "index",
			Usage: `index of a section to be used as a placeholder (useful if limiters refer to more than one section,
0 = replace all)`,
			Value: 0,
		},
	},
	Subcommands: []*cli.Command{},
}

App main application.

Functions

This section is empty.

Types

This section is empty.

Jump to

Keyboard shortcuts

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