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 and watch Using Projects to Collaborate, Track, and Merge Changes and Perform Code Reviews (4 min, 50 sec).

Not all Projects functionalities are available in MATLAB^® Online™.

Functions

`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.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

`addFile`	Add file or folder to project
`addFolderIncludingChildFiles`	Add folder 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)
`removeReference`	Remove project reference
`addStartupFile`	Add startup file to project
`addShutdownFile`	Add shutdown file to project
`removeStartupFile`	Remove startup file from project startup list
`removeShutdownFile`	Remove shutdown file from project shutdown list
`addShortcut`	Add shortcut to project
`removeShortcut`	Remove shortcut from project

`addLabel`	Attach label to project file
`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 (Since R2020a)
`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)

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

matlab.project.Project Project object

Create Projects

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

Add, move, rename, and open project files and folders.
- Find Project Files
- Add Labels to Project Files
- Create Custom Tasks
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.
Check for Compatibility Issues Using Project Upgrade
Check for compatibility issues or upgrade your project to the current MATLAB release.
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.
Use Source Control with Projects
Update, commit, merge changes, and view revision history directly from the project environment.
Clone Remote Git Repository into New Project
Clone a remote Git™ repository to create a local copy of a project.
Identify and Run Tests in MATLAB Projects
Identify and run tests in MATLAB projects.
Determine Order for Resolving Conflicts Using Dependency Analyzer
Use the Dependency Analyzer to determine the resolve merge conflicts order in a project.
Continuous Integration Using MATLAB Projects and Jenkins
Set up your project for CI in Jenkins^® and reduce test suite runtime using dependency cache.

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

How useful was this information?

Unrated 1 star 2 stars 3 stars 4 stars 5 stars