docker compose ls

O comando docker compose ls é utilizado para listar todos os projetos Docker Compose que estão sendo executados ou que foram criados no host atual. Ele fornece uma visão geral dos projetos, incluindo o nome, status, número de serviços, e diretório onde estão localizados.

Uso Básico

docker compose ls [OPTIONS]

Principais Opções

• -a, --all: Lista todos os projetos, independentemente de estarem em execução ou não. Por padrão, apenas os projetos em execução são listados.

• --filter key=value: Filtra a lista de projetos com base em critérios específicos. Por exemplo, --filter name=myproject exibirá apenas o projeto cujo nome é "myproject".

• --format string: Define o formato de saída. Pode ser table (padrão), json, ou yaml. Isso permite integrar a saída com outras ferramentas ou scripts.

• -q, --quiet: Exibe apenas os nomes dos projetos, sem detalhes adicionais. Útil para scripts que precisam apenas do nome do projeto.

Exemplos de Uso

1. Listar todos os projetos em execução:

   docker compose ls

   Exibe uma tabela com todos os projetos Docker Compose que estão em execução no host atual.

2. Listar todos os projetos, incluindo os parados:

   docker compose ls --all

   Inclui na lista os projetos que não estão em execução no momento.

3. Filtrar projetos por nome:

   docker compose ls --filter name=myproject

   Exibe apenas o projeto cujo nome é "myproject".

4. Exibir a lista de projetos em formato JSON:

   docker compose ls --format json

   A saída será exibida em formato JSON, ideal para integração com sistemas que processam dados nesse formato.

5. Exibir apenas os nomes dos projetos:

   docker compose ls -q

   Útil para capturar rapidamente os nomes dos projetos em execução, sem detalhes adicionais.

Saída Padrão

Quando você executa o comando docker compose ls sem nenhuma opção adicional, a saída padrão inclui as seguintes colunas:

• NAME: O nome do projeto.

• STATUS: O status do projeto, como running, exited, etc.

• CONFIG FILES: Lista de arquivos de configuração Docker Compose utilizados pelo projeto.

• SERVICES: O número de serviços definidos no projeto.

• PROJECT DIRECTORY: O diretório onde o projeto está localizado.

Casos de Uso Comuns

• Gerenciamento de Múltiplos Projetos: Quando você está executando vários projetos Docker Compose no mesmo host, o comando ls fornece uma visão clara de todos os projetos ativos.

• Verificação Rápida: Permite verificar rapidamente quais projetos estão em execução e em quais diretórios estão localizados.

• Automação: A opção --quiet é útil em scripts de automação para iterar sobre os projetos sem a necessidade de processar saídas detalhadas.

Considerações Finais

O comando docker compose ls é uma ferramenta conveniente para monitorar e gerenciar projetos Docker Compose em um ambiente de múltiplos projetos. Ele oferece uma maneira fácil de ver quais projetos estão ativos, onde estão localizados, e o status de cada um. Com opções para filtrar e formatar a saída, você pode ajustar o comando para atender às necessidades específicas de seu ambiente de desenvolvimento ou produção.