Skip to content

Describe Projects #69

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Aug 8, 2024
Merged

Describe Projects #69

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
412e2a3
Describe Projects
jordanstephens Aug 7, 2024
1175de4
Prefer .yaml instead of .yml
jordanstephens Aug 7, 2024
45c01a0
Addressing feedback
jordanstephens Aug 8, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/concepts/projects.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
title: Projects
description: A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yml` file.
sidebar_position: 200
---

# Projects

A _project_ refers to a cohesive collection of services which are defined and managed using a `compose.yaml` file.

## Project Names

The _project name_ can be defined in the compose file with [the `name` property](https://docs.docker.com/compose/compose-file/04-version-and-name/#name-top-level-element), otherwise the base name of the project directory will be used.

The project name may then be used when performing project-wide operations such as listing services, tailing logs, or deprovisioning. For example:
```
defang services --project-name <project-name>
defang tail --project-name <project-name>
defang compose down --project-name <project-name>
```

By default `defang` will use the project name from the `compose.yaml` file in the working directory. The [`--project-name` CLI flag](/docs/cli/defang) may be used when running `defang` from outside the working directory.