path — Query or replace the active session search path.
path reads or replaces the ordered path used for runtime function, script, class, package, MEX, and file resolution.
Syntax
oldpath = path
oldpath = path(path1)
oldpath = path(path1, path2)Inputs
path1- Type
Any- Required
- Yes
- Description
- Replacement path as a character row, string scalar, or RunMat numeric character-code row.
path1- Type
Any- Required
- Yes
- Description
- First path fragment.
path2- Type
Any- Required
- Yes
- Description
- Second path fragment.
Returns
oldpath- Type
StringScalar- Description
- Current path for query form or previous path for mutation forms, as a character row vector.
Errors
RunMat:path:TooManyOutputs- When
- More than one output is requested.
- Message
path: too many output arguments
RunMat:path:InvalidInput- When
- A path argument is not an admitted character row, string scalar, or numeric character-code row.
- Message
path: arguments must be character vectors or string scalars
RunMat:path:TooManyInputs- When
- More than two input arguments are provided.
- Message
path: too many input arguments
Read or replace the session search path
path with no input returns the ordered search-path entries as a character row vector. path(path1) replaces the list, while path(path1, path2) joins the two fragments with the platform path separator before replacing it. Mutation forms return the previous path.
The current working folder is searched before these explicit entries and is not included in the returned text. An empty replacement clears only the explicit entries.
Resolution and supported input forms
Changes apply immediately to later function, script, class, package, MEX, and file discovery in the same RunMat session. Each session owns its path state, so one session does not change another session's resolution order.
Portable code should pass character rows or string scalars. RunMat compatibility mode also accepts a dense real numeric row of Unicode scalar values, including an empty numeric array to clear the explicit path. Trailing singleton dimensions do not change a row into a page array. All input arguments are admitted before resident character codes are gathered; the resulting path and return value remain host text.
Examples
Read the current search path
p = path;
assert(ischar(p));
assert(size(p, 1) == 1);Temporarily replace and restore the search path
original = path;
old = path('runmat-addons');
assert(strcmp(old, original));
assert(strcmp(path, 'runmat-addons'));
path(old);
assert(strcmp(path, original));Append an entry
original = path;
extra = 'projects/analysis';
path(original, extra);
assert(contains(path, extra));
path(original);Prepend an entry
original = path;
extra = 'toolbox';
path(extra, original);
assert(startsWith(path, extra));
path(original);Prepend a recursively generated folder list
mkdir('submodules');
mkdir(fullfile('submodules', 'tooling'));
original = path;
tooling = genpath(fullfile('submodules', 'tooling'));
old = path(tooling, original);
assert(strcmp(old, original));
assert(contains(path, 'tooling'));
path(original);Set a path from numeric character codes in RunMat mode
original = path;
codes = uint16('extension-path');
path(codes);
assert(strcmp(path, 'extension-path'));
path(original);Using path with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how path changes the result.
Run a small path example, explain the result, then change one input and compare the output.
FAQ
Does path include the current folder?⌄
No. The current folder is an implicit first search location; path returns only the explicit ordered entries.
Can I clear the explicit path?⌄
Yes. path('') clears the explicit entries while leaving the current folder available for resolution.
How do I append or prepend?⌄
Use path(path, newEntry) to append or path(newEntry, path) to prepend. addpath provides validated folder-oriented forms for the same common operations.
Do later calls see a change immediately?⌄
Yes. Runtime callable and file discovery read the active session's ordered path for each resolution request.
Does one session change another session's path?⌄
No. Active RunMat sessions own independent path state. Calls made without a session use the process compatibility state.
Can path accept numeric character codes?⌄
RunMat mode accepts a dense real numeric row as a convenience extension. MATLAB compatibility modes require character or string text.
Related Io functions
Repl Fs
addpath · 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 · 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 path is executed, line by line, in Rust.
- View the source for path 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.