CLI

CLI#

For example, stringcalc gauge --suggest can be used to suggest strings. -T, -L, -P (tension, scale length, pitch) can be specified more than once to get results for multiple strings.

With uv, you can install stringcalc globally with:

uv tool install stringcalc[cli]

or run it in an ephemeral environment with:

uvx stringcalc[cli]

stringcalc#

Usage

stringcalc [OPTIONS] COMMAND [ARGS]...

Options

--version#

Print version and exit.

Default:

False

frets#

Display fret distance table for N frets and scale length L.

Usage

stringcalc frets [OPTIONS]

Options

-N, --number <N>#

Number of frets, starting from nut (fret 0).

Default:

17

-L, --scale-length <L>#

Required Scale length.

--float-format <float_format>#

Format for float-to-string conversion.

Default:

'%.3f'

gauge#

Compute gauge(s) from string information.

IMPORTANT: currently must use T in lbf and L in inches, returning result(s) in inches.

Usage

stringcalc gauge [OPTIONS]

Options

-T, --tension <T>#

Required Desired tension

-L, --length <L>#

Required String length (scale length).

-P, --pitch <P>#

Required Pitch in scientific pitch notation (e.g. ‘E4’).

--suggest, --no-suggest#

If true, suggest gauges (strings) to use. If false, compute exact gauge.

Default:

False

--type <types>#

String type. Can specify multiple times if using –suggest. For –suggest, defaults to D’Addario phosphor bronze and plain steel (‘DA:PB’, ‘DA:PL’). If not using –suggest, must specify exactly one type (no default).

-N, --nsuggest <nsuggest>#

Number of suggestions. Only relevant if using –suggest.

Default:

3

--fanned#

Fanned calculations. Must provide two scale lengths. Assumed if two scale lengths are provided.

-w, --nut-width <nut_width>#

Neck width at (center of?) nut (for fanned calculations). Required if using –fanned.

-e, --edge-space <edge_space>#

Edge space, between the edge of the neck and the center of the first string. You can specify one (used for both left and right) or two (left, right). The default is 5/32” on the left and 1/8” on the right. Only used for fanned calculations.

--float-format <float_format>#

Format for float-to-string conversion. Only relevant if using –suggest.

Default:

'%.3f'

--column-info, --no-column-info#

Print column definitions under table. Only relevant if using –suggest.

Default:

True

--verbose, --no-verbose#
Default:

False

length#

Calculate the scale length implied by spec ‘a-b=d’.

Where a and b are fret numbers (use ‘0’ or ‘n’ for nut, ‘s’ for saddle) and d is the corresponding distance.

Usage

stringcalc length [OPTIONS] SPEC

Options

--round <round_>#

Round result to this decimal precision.

--verbose, --no-verbose#
Default:

False

Arguments

SPEC#

Required argument