Jix API Reference

`script`

Source: src/jix/base.js#L190

Template tag function for creating executable script files.

Parameters:

Template string containing script content

Returns: Effect

`textfile`

Source: src/jix/base.js#L181

Template tag function for creating text files.

Parameters:

Template string containing file content

Returns: Effect

`importScript(origin)`

Source: src/jix/base.js#L240

Import an executable script file.

Parameters:

origin (string) - Path to script file

Returns: Effect with additional name property set to file basename

`importTextfile(origin)`

Source: src/jix/base.js#L227

Read a text file from the filesystem and create an effect containing its contents.

Parameters:

origin (string) - Path to file to import

Returns: Effect with additional name property set to file basename

`copy(from, to)`

Source: src/jix/base.js#L57

Copy a file to a destination path.

Parameters:

from (string | Effect) - Source path
to (string) - Destination path

Returns: Effect

`link(origin, path)`

Source: src/jix/base.js#L25

Create a hard link.

Parameters:

origin (string | Effect) - Source path
path (string) - Link destination path (tilde expanded)

Returns: Effect

`symlink(origin, path)`

Source: src/jix/base.js#L49

Create a symbolic link. Equivalent to link(origin, path, true).

Parameters:

origin (string | Effect) - Source path
path (string) - Link destination path

Returns: Effect

`alias(mapping)`

Source: src/jix/base.js#L68

Create command aliases in the jix bin directory.

Parameters:

mapping (Object) - Maps alias names to target paths/effects

Returns: Effect

`dir(path, extraArgs={})`

Source: src/jix/base.js#L127

Create a directory at the specified path using mkdir -p. Uninstall will only remove the directory if it is empty.

Parameters:

path (string) - Directory path to create
extraArgs (Object, optional) - Additional effect properties

Returns: Effect

`customEffect({install, uninstall, dependencies, ...other})`

Source: src/jix/base.js#L94

Create an effect with custom shell commands for install/uninstall.

Parameters:

install (string, optional) - Shell command to run on install
uninstall (string, optional) - Shell command to run on uninstall
dependencies (Array, optional) - Array of EffectOrFn dependencies
Additional properties passed to effect

Returns: Effect

`existingCommand(command, {errorMessage}={})`

Source: src/jix/base.js#L108

Create an effect that verifies a command exists on the system.

Parameters:

command (string, required) - Command name to check for
errorMessage (string, optional) - Custom error message if command not found

Returns: Effect with str property set to the command name

`stateDir(id)`

Source: src/jix/stateDir.js#L8

Create a state directory in ~/.jix/db/<id> that persists across installs/uninstalls.

Parameters:

id (string) - Non-empty identifier for the state directory

Returns: Effect

`str`

Source: src/jix/base.js#L143

Template tag function for creating string effects with dependency tracking.

Parameters:

Template string with possible effect interpolations

Returns: Effect with str property containing the resulting string

`build`

Source: src/jix/base.js#L254

Template tag function for building artifacts from shell scripts. The build script is executed in a temporary directory, and the build result should be written to the path given by the $out environment variable.

Parameters:

Template string containing shell script

Returns: Effect with build output path in $out

`dirWith(files)`

Source: src/jix/base.js#L272

Create a directory containing specified files.

Parameters:

files (Object, required) - Maps file names to source paths or effects

Returns: Effect representing the directory

`target()`

Source: src/jix/base.js#L318

Get the current target context (host and user).

Returns: Object with host and user properties

`dedent`

Source: src/jix/dedent.js#L4

Remove common leading whitespace from template strings.

Parameters:

templateStrings (Array) - Template string parts
...values - Interpolated values

Returns: string

`effect(obj)`

Source: src/jix/effect.js#L129

Create an effect from properties or dependencies.

Parameters:

obj (Object | Array) - Effect properties or array of dependencies
- install (Array, optional) - Install action specification
- uninstall (Array, optional) - Uninstall action specification
- build (Array, optional) - Build action specification
- dependencies (Array, optional) - EffectOrFn dependencies
- path (string, optional) - File system path
- str (string, optional) - String representation

Returns: Effect

`service({name, exec, system, runOnInstall, noUninstall, dependencies})`

Source: src/jix/service/index.js#L26

Create a persistent background service.

Parameters:

name (string, required) - Service identifier (alphanumerics, dots, hyphens, underscores, and @ only)
exec (string | Effect, required) - Path to executable or script effect
system (boolean, optional) - Install as system service if true (default: false)
runOnInstall (boolean, optional) - Start service on install (default: true)
noUninstall (boolean, optional) - Skip uninstallation (default: false)
dependencies (array, optional) - Additional dependencies for the service (default: [])