Syntax & Checklist

Open
#2 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
25/100
Issue type
Feature
Clarity
Mostly clear
Activity status
Stale
Tech stack
php
Domain
cli

Research direction

No files, tests, or entry points are named in the issue. Begin by locating the existing CLI command structure, then compare its behavior with each listed syntax and option; done means the full checklist works, including log selection, line counts, paths, unions, and informational messages.

Written by the indexing model from the issue text.

Description

Syntax

  • ee log => displays help and exit
  • ee log show --cli => displays easyengine's own logs
  • ee log show --global => displays all logs including all sites, all services and cli
  • ee log show --n=<line-count> => start with last number of . Default is 10. This is passed to tail command internally as tail -n <line-count>

Site Syntax

  • ee log show <sitename> => displays nginx + php + wp (if applicable) logs for a site
  • ee log show <sitename> --all => displays all local logs, including service logs
  • ee log show <sitename> --nginx => displays nginx logs for a site
  • ee log show <sitename> --php => displays php logs for a site
  • ee log show <sitename> --wp => displays wp dbeug log for a site
  • ee log show <sitename> --services => displays service logs only for a site
  • ee log show <sitename> --mysql => displays mysql logs for a site
  • ee log show <sitename> --redis => displays redis logs for a site
  • ee log show <sitename> --access => displays nginx & php access logs for a site
  • ee log show <sitename> --error => displays nginx & php error logs for a site

Service Syntax

  • ee log show --services => displays service logs only for all global services
  • ee log show --services=<service-name> => displays service logs only for all global service whose name is specified

Extra checklist

  • Service related flags will display an INFO message saying "example.com uses the global container for X so logs may have additional messages from other sites".
  • Multiple logs flag can be specified e.g. --nginx --php. These will do UNION of all logs files associated with each flag.
  • All show commands will have ee log path command which will display only log file path names rather than actual logs.
Dominant language
PHP
Stars
2
Forks
4
PR merge metrics
No merged PRs in 30d

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from EasyEngine/log-command

All issues in EasyEngine/log-command

Similar issues

More PHP issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.