Skip to main content

ctx.script

The ctx.script value identifies the file the running script was read from, so a script can find files that sit next to it regardless of the directory it runs in.

Usage​

ctx.script.path
ctx.script.directory

Returns​

A value with two attributes, or None when the script has no source file:

path
The absolute path of the script file.
directory
The absolute path of the directory that contains the script file.

The value is set for a standalone script file, where symbolic links are resolved to the real file, and for a workflow, custom command, or hook step whose script comes from a local !include or !include.raw file. An inline script: | body or a script read from stdin with atmos - has no file, so ctx.script is None.

Examples​

Read a file next to the script​

#!/usr/bin/env atmos
template = fs.read_file(ctx.script.directory + "/template.txt")
print(template)

The function fs.read_file resolves relative paths against the working directory, so building the path from ctx.script.directory works from any directory the script is started in.

Show where a script lives​

if ctx.script != None:
    ui.info("Running " + ctx.script.path)
else:
    ui.info("Running an inline script")

Load a helper module beside the script​

The load() statement already resolves relative paths against the script file, so most scripts do not need ctx.script for that:

load("lib/helpers.star", "deploy")

Related​