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

Developer Docs for Ayon Launcher run and interactive cli options #230

Open
2 tasks done
Lypsolon opened this issue Sep 4, 2024 · 0 comments
Open
2 tasks done

Developer Docs for Ayon Launcher run and interactive cli options #230

Lypsolon opened this issue Sep 4, 2024 · 0 comments
Labels
type: enhancement New feature or request

Comments

@Lypsolon
Copy link

Lypsolon commented Sep 4, 2024

Is there an existing issue for this?

  • I have searched the existing issues.

Please describe the feature you have in mind and explain what the current shortcomings are?

Currently there is only shell documentation for the AYON core Cli options. the shell docs are great for explaining the feature but its not really possible to just guess the feature.

it would be great if we can add a simple information about this system to the Dev docs. this would make it easy to find the feature.

Context:
i was searching for a way to start console for AYON launcher from an ssh session where i only have one shell (This would also be great for automatic testing systems) and i was only able to find it after asking @BigRoy.

How would you imagine the implementation of the feature?

i think a simple section that mentions that there are launcher cli tools would be enough.
just something like:

Launcher Cli

here is some context for what launcher Cli is and what we intend.

  • run: what dose it do
  • interactive: what dose it do
  • .....
    for more info run ./ayon --help

Are there any labels you wish to add?

  • I have added the relevant labels to the enhancement request.

Describe alternatives you've considered:

No response

Additional context:

No response

@Lypsolon Lypsolon added the type: enhancement New feature or request label Sep 4, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type: enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant