addpath — Add validated folders to the active session search path.
addpath prepends or appends folders to the ordered path used by runtime callable and file resolution.
Syntax
oldpath = addpath(folder1, ..., folderN)
oldpath = addpath(folder1, ..., folderN, position)
oldpath = addpath(folder1, ..., folderN, options)Inputs
folder- Type
Any- Required
- Variadic
- Description
- One or more folders or text containers, followed by optional position flags.
Returns
oldpath- Type
StringScalar- Description
- Previous search path as a character row vector.
Errors
RunMat:addpath:InvalidFolder- When
- A folder argument is not admitted text, a text container, or a mode-admitted numeric character-code row.
- Message
addpath: folder names must be character vectors, strings, string arrays, or cell arrays of text
RunMat:addpath:NotEnoughInputs- When
- No nonempty folder token is provided.
- Message
addpath: at least one folder must be specified
RunMat:addpath:InvalidPosition- When
- More than one position option is provided.
- Message
addpath: position option must be '-begin' or '-end' and may only appear once
Add folders to the session search path
addpath validates folders and adds them to the ordered path used to resolve functions, scripts, classes, packages, MEX files, and data files. The default position is the beginning; '-end' appends and '-begin' selects the beginning explicitly.
Arguments may be character vectors, string values, string arrays, or cells containing those text forms. A multi-row character array contributes one folder per row. A path-list string is split with the platform separator, which lets addpath consume genpath output directly.
Ordering, validation, and compatibility
Relative folders are resolved from the current working folder, ~ is expanded, and every folder must exist. Existing occurrences are removed before insertion, so each normalized folder appears once. A call either validates all requested folders and updates the path or leaves it unchanged.
The '-frozen' option is accepted for source compatibility but does not create a separate frozen tier. RunMat mode also accepts a dense real numeric row of Unicode scalar values; MATLAB compatibility modes require text. Resident numeric rows pass compatibility admission before one host gather.
The returned character row is the previous path. Changes apply immediately to later resolution in the same session and do not alter another session's path.
Examples
Add a folder at the beginning
mkdir('toolbox');
original = path;
old = addpath('toolbox');
assert(strcmp(old, original));
assert(contains(path, 'toolbox'));
path(original);Append a folder
mkdir('shared');
original = path;
addpath('shared', '-end');
assert(contains(path, 'shared'));
path(original);Use command syntax
mkdir('SourceCode');
original = path;
addpath ./SourceCode
assert(contains(path, 'SourceCode'));
path(original);Add several folders
mkdir('alpha');
mkdir('beta');
original = path;
addpath('alpha', 'beta', '-end');
assert(contains(path, 'alpha'));
assert(contains(path, 'beta'));
path(original);Add folders from a string array
mkdir('algorithms');
mkdir('visualization');
original = path;
folders = ["algorithms", "visualization"];
addpath(folders);
assert(contains(path, 'algorithms'));
assert(contains(path, 'visualization'));
path(original);Add a generated folder tree
mkdir('tree');
mkdir(fullfile('tree', 'child'));
original = path;
addpath(genpath('tree'));
assert(contains(path, 'child'));
path(original);Accept the frozen compatibility option
mkdir('vendor');
original = path;
addpath('vendor', '-frozen');
assert(contains(path, 'vendor'));
path(original);Restore the previous path
mkdir('temporary');
original = path;
old = addpath('temporary');
assert(strcmp(old, original));
path(old);Use numeric character codes in RunMat mode
mkdir('codes');
original = path;
addpath(uint16('codes'));
assert(contains(path, 'codes'));
path(original);Using addpath with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how addpath changes the result.
Run a small addpath example, explain the result, then change one input and compare the output.
FAQ
Are relative folders supported?⌄
Yes. They are resolved from the current working folder and stored in normalized absolute form.
How do I append instead of prepend?⌄
Pass '-end'. The default and '-begin' place folders at the beginning.
What happens to duplicate entries?⌄
Existing occurrences are removed before the requested ordering is applied, so a normalized folder appears once.
Can I pass genpath output?⌄
Yes. Path-list text is split using the platform separator.
What does -frozen do?⌄
RunMat accepts the option for source compatibility. It currently has no separate path-state effect.
Can I pass numeric character codes?⌄
RunMat mode accepts a dense real row, including a resident row after compatibility admission. MATLAB compatibility modes require text.
What value does addpath return?⌄
It returns the previous path as a character row so it can be restored with path(oldpath).
Related Io functions
Repl Fs
cd · copyfile · delete · dir · exist · fileattrib · fileparts · filesep · fullfile · genpath · getenv · getpref · isenv · isfile · isfolder · ispref · ls · matlabroot · memmapfile · memmapfile.subsasgn · memmapfile.subsref · mkdir · movefile · open · opentoline · path · pathsep · pcode · pwd · readstruct · rehash · restoredefaultpath · rmdir · rmpath · run · savepath · setenv · setpref · system · tempdir · tempname · uigetdir · uigetfile · uiputfile · unsetenv · userpath · what · winqueryreg · xmlread · xmlwrite
Tabular
arrayDatastore · csvread · csvwrite · detectImportOptions · dlmread · dlmwrite · fileDatastore · getvaropts · parquetDatastore · parquetinfo · parquetread · readcell · readmatrix · readtable · readtimetable · setvaropts · setvartype · spreadsheetImportOptions · writecell · writematrix · writetable · writetimetable · xlsread · xlswrite
Data
commit · data.copy · data.create · data.delete · data.exists · data.export · data.import · data.inspect · data.list · data.move · data.open · DataArray.chunk_shape · DataArray.codec · DataArray.dtype · DataArray.fill · DataArray.name · DataArray.rank · DataArray.read · DataArray.resize · DataArray.shape · DataArray.write · Dataset.array · Dataset.arrays · Dataset.attrs · Dataset.begin · Dataset.get_attr · Dataset.has_array · Dataset.id · Dataset.path · Dataset.refresh · Dataset.set_attr · Dataset.set_attrs · Dataset.snapshot · Dataset.version · DataTransaction.abort · DataTransaction.commit · DataTransaction.create_array · DataTransaction.delete_array · DataTransaction.fill · DataTransaction.id · DataTransaction.resize · DataTransaction.set_attr · DataTransaction.set_attrs · DataTransaction.status · DataTransaction.write
Filetext
fclose · feof · fgetl · fgets · fileread · filewrite · fopen · fprintf · fread · frewind · fwrite · readlines · writelines
Import
Json
Source you can read
Every RunMat function's source is public. Read exactly how addpath is executed, line by line, in Rust.
- View the source for addpath in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.