mirror of
https://github.com/edgelesssys/constellation.git
synced 2025-05-04 07:15:05 -04:00
Add package design goals to CLI package documentation
Signed-off-by: Daniel Weiße <dw@edgeless.systems>
This commit is contained in:
parent
946942ba68
commit
99c579b45a
10 changed files with 56 additions and 135 deletions
|
@ -8,5 +8,15 @@ SPDX-License-Identifier: AGPL-3.0-only
|
|||
Package cmd provides the Constellation CLI.
|
||||
|
||||
It is responsible for the interaction with the user.
|
||||
|
||||
Logic should be kept to input/output parsing whenever possible.
|
||||
Any more complex code should usually be implemented in one of the other CLI packages.
|
||||
|
||||
The code here should be kept as cloud provider agnostic as possible.
|
||||
Any CSP specific tasks should be handled by the "cloudcmd" package.
|
||||
|
||||
All filepaths handled by the CLI code should originate from here.
|
||||
Common filepaths are defined as constants in the global "/internal/constants" package.
|
||||
To generate workspace correct filepaths for printing, use the functions from the "workspace" package.
|
||||
*/
|
||||
package cmd
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue