Skip to content
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.

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

ctop: add page #12683

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

ctop: add page #12683

wants to merge 5 commits into from

Conversation

saliaku
Copy link

@saliaku saliaku commented Apr 26, 2024

  • The page(s) are in the correct platform directories: common, linux, osx, windows, sunos, android, etc.
  • The page(s) have at most 8 examples.
  • The page description(s) have links to documentation or a homepage.
  • The page(s) follow the content guidelines.
  • The PR title conforms to the recommended templates.
  • Version of the command being documented (if known):

@saliaku saliaku requested a review from cyqsimon as a code owner April 26, 2024 19:53
@github-actions github-actions bot added the new command Issues requesting creation of a new page. label Apr 26, 2024
@kbdharun kbdharun changed the title ctop on tldr ctop: add page Apr 27, 2024
- Show tree view by default:

`ctop --tree`
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There appears to be no such flag.

$ ctop --tree
flag provided but not defined: -tree
Usage of ctop:
  -a	show active containers only
  -connector string
    	container connector to use (default "docker")
  -f string
    	filter containers
  -h	display this help dialog
  -i	invert default colors
  -r	reverse container sort order
  -s string
    	select container sort field
  -v	output version information and exit

and https://github.com/bcicen/ctop?tab=readme-ov-file#options

also could you give some more examples once this is addressed since there are more things which need documenting.

pages/linux/ctop.md Outdated Show resolved Hide resolved
pages/linux/ctop.md Outdated Show resolved Hide resolved
pages/linux/ctop.md Outdated Show resolved Hide resolved
pages/linux/ctop.md Outdated Show resolved Hide resolved
Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
@spageektti
Copy link
Collaborator

Hello @saliaku. Thank you for your contribution. I remind you about this PR.

done sorry for the delay

Co-authored-by: CleanMachine1 <78213164+CleanMachine1@users.noreply.github.com>
Copy link
Collaborator

@spageektti spageektti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for your contribution again. I made some suggestions - I added short option mnemonics.

> Instantly visualize container performance and health with real-time metrics on CPU, memory, and block IO usage.
> More information: <https://github.com/bcicen/ctop>.
- Show only active containers:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Show only active containers:
- Show only [a]ctive containers:


`ctop -r`

- Invert the default colors:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Invert the default colors:
- [i]nvert the default colors:


`ctop -a`

- Reverse the container sort order:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Reverse the container sort order:
- [r]everse the container sort order:


`ctop -i`

- Display help:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- Display help:
- Display [h]elp:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new command Issues requesting creation of a new page.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants