> For the complete documentation index, see [llms.txt](https://docs.codeocean.com/user-guide/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.codeocean.com/user-guide/compute-capsule-basics/managing-capsules.md).
# Managing Capsules
You can easily manage all your Capsules on the **My Capsules** page, or directly from the Code Ocean user interface for each particular Capsule. Code Ocean makes collaboration easier, by allowing you to share, edit access, and archive Capsules directly from the user interface.
## Sharing Capsules
### About Sharing a Capsule
Sharing a Capsule means that others can continue working from what you’ve developed—either in the same Capsule or in a duplicate Capsule. You can set Capsule permissions to collaborate with users and groups within your organization. Only authorized users can view/duplicate, or edit your Capsule. Shared Capsules are updated in near real-time with any changes made in the Capsule.
It is best practice to utilize Group sharing to ensure that new users will have all relevant Capsules, Data, and Pipelines available to them when they join, and that there will be no lost assets when team members leave.
Reach out to your Admin to configure Groups through your organization's chosen Identity Provider.
{% hint style="info" %}
You can share a Capsule with secrets/credentials just like any other Capsule. To learn more about setting up secrets in Code Ocean, refer to the[ Secret Management Guide](/user-guide/compute-capsule-basics/secret-management-guide.md).
Navigate to[ Run a Shared Capsule with Secrets](/user-guide/compute-capsule-basics/managing-capsules/collaborating-a-capsule-with-secret.md#run-a-shared-capsule-with-missing-credentials) to learn how to run a shared Capsule with a secret.
{% endhint %}
### Managing Capsule Permissions
#### Types of Permissions
The three types of permission for a Capsule are: Owner, Editor, and Viewer.
| Action | Viewer | Editor | Owner |
| ----------------------------- | ------------------------ | ------------------------ | ------------------------ |
| View a Capsule |
✅
|
✅
|
✅
|
| Download a Capsule |
✅
|
✅
|
✅
|
| Export a Capsule |
✅
|
✅
|
✅
|
| Edit files in a Capsule |
❌
|
✅
|
✅
|
| Execute a Reproducible Run |
✅
|
✅
|
✅
|
| Work from a Cloud Workstation |
❌
|
✅
|
✅
|
| Edit Capsule's permissions |
❌
|
✅
|
✅
|
| Delete a Capsule |
❌
|
❌
|
✅
|
### Setting Permissions for Collaborators
1. Click **Share** at the top right corner of the Capsule to open the sharing and permissions settings.
2. Type the name of the collaborator to invite or select the name from the drop-down menu. If groups are configured in your organization, they will also appear in the drop-down menu.
3. Click the desired user’s name/email address in the dropdown to add the collaborator. The system adds the user to the Capsule's permissions list. The permission level will be set as Viewer by default.
4. To change a user's permissions or remove a user, click the drop-down menu next to the desired user which shows their current permissions and choose the relevant option.
5. Click **Save** in the bottom right corner of the pop up to close the Capsule sharing and permissions settings.
{% hint style="info" %}
You can add more than one collaborator by repeating steps 2-3 before Saving.
To make a Capsule visible to all internal users, under General Access, Everyone select Viewer
To share the Capsule with Data Assets, check **Share Assets**. To share only the Capsule without Data Assets, ensure that **Share Assets** is deselected.
{% endhint %}
### Owner/Admin Ability to Capture, Delete, and Rename Runs
Capsule Owners and Admins have the ability to rename and delete runs from other users, as well as create Result Data Assets from those runs. Code Ocean Admins also have the ability to see all runs on Release Capsules and rename or delete those runs.
### Working on a Shared Capsule
#### View Mode
When you add a collaborator with the permission to view the Capsule, the collaborator can view all the folders and files from the Capsule IDE, download individual files, export, and duplicate the Capsule.
To execute or modify code in the Capsule as a Viewer, you will need to duplicate the Capsule prior to editing.
Anyone with View Access can attach secrets to the Capsule that is shared with them
#### Edit Mode
When you share a Capsule with the edit permission, the collaborator can change any file's content and execute code in a Capsule. Only one user can edit the shared Capsule at any given time. All collaborators can view the same Capsule simultaneously. When a collaborator is editing the Capsule, all others will see the Capsule in the view-only mode indicated by a message on top of the center section of the Capsule IDE and the deactivated buttons in the right Timeline section.
Click **Start editing** to begin editing above the Editor in the center. If a collaborator's name appears in the message, they are forced into the read-only mode after your click.
{% hint style="warning" %}
Before you decide to edit the Capsule when a collaborator appears to be editing, it is strongly recommended that you communicate with your collaborator in advance, so they don't lose their work.
{% endhint %}
When you're done, click **Finish editing**.
### Duplicating a Capsule
How to create a private copy of either released or unreleased code.
Duplicating a Capsule allows you to create a copy of it while keeping the original unchanged. To duplicate a compute capsule:
1. Navigate to your My Capsules Dashboard,
2. Click on the Capsule you would like to duplicate, which will open the Capsule IDE
3. Click Capsule in the menu at the top of the screen
4. Select Duplicate. This process will create an exact copy of the Capsule, which will open and be added directly to your My Capsules Dashboard
### Archiving a Capsule
Capsules and Data Assets can be archived to reduce clutter in the Capsules/Data Assets list. Archiving removes a Capsule/Data Asset from the 'All' view, making them accessible through the Archive view
1. To begin the process of archiving your Capsule, Navigate to the **My Capsules** **Dashboard**.
2. To arching your Capsule directly from the **My Capsules Dashboard**, hover over the desired Capsule and click **Archive** in the toolbar selection that appears.
### Restoring an archived Capsule
1. To view an archived Capsule/Data Asset, click **Archive** in the menu. All the archived Capsules/Data Assets are listed.
2. To restore a Capsule from the Archive, scroll the cursor over the Capsule and click the **Restore Capsule** icon in the toolbar.
3. Click **Back to My Capsules** to return
### **Modify/Remove Capsule Permissions**
1. Navigate to your Capsule and click **Share** at the top right corner of the screen to open the sharing and permissions settings.
2. Navigate to the collaborator whose permissions you would like to modify.
3. Change or remove a user's permissions by clicking on the drop-down menu next to the user and selecting the appropriate option.
4. Click **Save** to close the Capsule sharing and permissions settings.
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.codeocean.com/user-guide/compute-capsule-basics/managing-capsules.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
### Working on a Shared Capsule
#### View Mode
When you add a collaborator with the permission to view the Capsule, the collaborator can view all the folders and files from the Capsule IDE, download individual files, export, and duplicate the Capsule.
To execute or modify code in the Capsule as a Viewer, you will need to duplicate the Capsule prior to editing.
Anyone with View Access can attach secrets to the Capsule that is shared with them
