Projects

Organize large projects by managing and sharing files and settings, finding required files, and interacting with source control

Projects can help you organize your work and collaborate. Use projects to find files required to run your code, manage and share files and settings, and interact with source control. For more information about projects, see Create Projects.

Functions

expand all

Create and Export Projects

`currentProject`	Get current project
`openProject`	Load an existing project
`isLoaded`	Determine if project is loaded
`reload`	Reload project
`close`	Close project
`export`	Export project to archive
`matlab.project.extractProject`	Extract project from archive (Since R2022b)
`matlab.project.createProject`	Create blank project
`matlab.project.currentProject`	Get project if open
`matlab.project.convertDefinitionFiles`	Change definition file type of project (Since R2020b)
`matlab.project.deleteProject`	Stop folder management and delete project definition files
`matlab.project.loadProject`	Load project
`matlab.project.rootProject`	Get root project

Setup Projects

`addFile`	Add files or folders to project
`addFolderIncludingChildFiles`	Add folders and child files to project
`removeFile`	Remove file or folder from project
`addPath`	Add folder to project path
`removePath`	Remove folder from project path
`addReference`	Add referenced project to project
`listAllProjectReferences`	List all projects in reference hierarchy of current project (Since R2021a)
`listShutdownIssues`	List all issues that occur when project closes (Since R2025a)
`listStartupIssues`	List all issues that occur when project opens (Since R2025a)
`removeReference`	Remove project reference
`addStartupFile`	Add startup file to project
`addShutdownFile`	Add shutdown file to project
`removeStartupFile`	Remove file from project startup files
`removeShutdownFile`	Remove file from project shutdown files
`addShortcut`	Add shortcut to project
`removeShortcut`	Remove shortcut from project

Manage Project Files

`addLabel`	Attach label to project files
`createLabel`	Create project label
`removeLabel`	Remove label from project
`findLabel`	Get project file label
`createCategory`	Create category of project labels
`findCategory`	Find project category of labels
`removeCategory`	Remove project category of labels
`findFile`	Find single project file by name
`findFiles`	Find project files by category or label name (Since R2024a)
`listModifiedFiles`	List modified files in project
`listRequiredFiles`	Get files required by specified project files
`listImpactedFiles`	Get files impacted by changes to specified project files (Since R2021a)
`listAllProjectReferences`	List all projects in reference hierarchy of current project (Since R2021a)
`refreshSourceControl`	Update source control status of project files
`runChecks`	Run all project checks
`updateDependencies`	Update project dependencies
`matlab.project.isUnderProjectRoot`	Determine whether file or folder is under project root folder (Since R2023a)
`matlab.project.isFileInProject`	Determine whether file or folder belongs to project (Since R2023b)

Tools

Dependency Analyzer

Visualize dependencies, find required files, and assess the impact of changes (Since R2023a)

Objects

expand all

Project Objects

matlab.project.Project Project object

Topics

Create Projects

Create projects in MATLAB^® to organize and share your work with others.
Manage Project Files

Add, move, rename, label, group, and find project files and folders.
Analyze Project Dependencies
Find required files for a whole project or for specified files, resolve problems, and control options for add-ons and incremental analysis.
Compare MATLAB Projects
You can compare project definition files.
Componentize Large Projects
Organize large projects using referenced projects.
Share Projects
Package and share projects as zip files, by email, as a toolbox, or by making it publicly available on a connected source control tool.
Reduce Test Runtime on CI Servers
Set up your project for CI in Jenkins^® and reduce test suite runtime using dependency cache and impact analysis.

Related Information

Source Control

Featured Examples

Explore an Example Project

Explore how project tools can help you organize your work using the TimesTableApp.

Open Live Script