Project Setup

Organize work into projects, automate startup and shutdown, find frequent tasks, reuse standard template settings

Projects help you to organize large modeling projects by finding required files, managing and sharing files and settings, and interacting with source control. See What Are Projects? and watch Using Projects to Collaborate, Track, and Merge Changes and Perform Code Reviews (4 min, 50 sec).

Functions

expand all

Create, Load, and Export Projects

`currentProject`	Get current project
`openProject`	Load an existing 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
`Simulink.createFromTemplate`	Create model or project from template
`Simulink.findTemplates`	Find model or project templates with specified properties
`Simulink.exportToTemplate`	Create template from model or project

Legacy API

`simulinkproject`	(Not recommended) Open project and get project object
`slproject.create`	(Not recommended) Create blank project
`slproject.getCurrentProjects`	(Not recommended) List all top-level projects
`slproject.loadProject`	(Not recommended) Load project

Set Up Project Files

`addFile`	Add file or folder to project
`addFolderIncludingChildFiles`	Add folder and child files to project
`addPath`	Add folder to project path
`addReference`	Add referenced project to project
`addShortcut`	Add shortcut to project
`addShutdownFile`	Add shutdown file to project
`addStartupFile`	Add startup file to project
`findFile`	Find single project file by name
`findFiles`	Find project files by category or label name (Since R2024a)
`isLoaded`	Determine if project is loaded
`reload`	Reload project
`removeFile`	Remove file or folder from project
`removePath`	Remove folder from project path
`removeReference`	Remove project reference
`removeShortcut`	Remove shortcut from project
`removeShutdownFile`	Remove shutdown file from project shutdown list
`removeStartupFile`	Remove startup file from project startup list

Legacy API

simulinkproject (Not recommended) Open project and get project object

Topics

Project Creation

Create a New Project from a Folder
Automatic project creation: Easily turn a folder to a project and manage your files, data, and environment in one place.
Create a Project from a Model
Create a project to organize your model and any dependent files. Simulink^® runs dependency analysis on your model to identify required files and a project root location that contains all dependencies.
Add Files to the Project
Add files in the project files view or programmatically.
Create a New Project from an Archived Project
Create a new project from an archived project.
Create a New Project Using Templates
In a project, use templates to create and reuse a standard project structure.
Open Recent Projects
Open recent projects from MATLAB^® or Simulink.
Specify Project Details, Startup Folder, and Derived Files Folders
View and edit details such as the name, description, project root, startup folder, and generated files folders.
Explore Project Tools with the Airframe Project
Try an example project to see how the tools can help you organize your work.
Set MATLAB Projects Preferences
Specify project definition files type, detect project files shadowed by open models, and detect project-wide references when renaming, removing and deleting files.

Startup and Shutdown Automation

Specify Project Path
The project can manage your path automatically when you open and close projects.
Automate Startup Tasks
In a project, startup files help you set up the environment for your project.
Automate Shutdown Tasks
In a project, shutdown files help you clean up the environment for the current project when you close it.

Frequent Task Shortcuts

Create Shortcuts to Frequent Tasks
In a project, create shortcuts for common project tasks and to make it easy to find and access important files and operations.
Use Shortcuts to Find and Run Frequent Tasks
In a project, use shortcuts to make it easy for any project user to find and access important files and operations.

Project Template Creation

Create Templates for Standard Project Settings
To reuse scripts and files for a standard project setup, create templates from projects, edit templates, or explore example templates.

About Projects

What Are Projects?
Use projects to help you organize your work. Find all your required files; manage and share files, settings, and user-defined tasks; and interact with source control.
What Can You Do with Project Shortcuts?
In a project, use shortcuts to make it easy for any project user to find and access important files and operations.
Sharing Projects
Collaborate by sharing projects by email, archive file, template, MATLAB toolbox, or on GitHub^®.

Featured Examples

Get Started with MATLAB Projects

Use an existing project to manage the files within your design. You can automate startup and shutdown tasks, add shortcuts for common tasks, run checks, upgrade project files, analyze project dependencies, and share your project.

Open Live Script

Create and Reference a Project Programmatically

Programmatically create a new project and add it as a reference project in your main project. It covers how to create a project from the command line, add files and folders, set up the project path, define project shortcuts and create a reference to the new project in another project.

Open Live Script

Using a Project with Git

Use a project to manage the files within your design. Starting with an existing project that is already checked into source control, this example shows how to view modified files, compare file revisions, and analyze project dependencies.

Open Live Script