Documentation
¶
Index ¶
Constants ¶
View Source
const MakefileName = "Makefile"
MakefileName is the Makefile `sal init` writes into a project.
Variables ¶
View Source
var ErrDescriptionRequired = errors.New("a description of the project is required; answer the prompt or pass --description")
ErrDescriptionRequired is returned when neither --description nor the prompt gave a description, since a project is not initialized without one.
View Source
var ErrIaCWithSalModule = errors.New("--with-iac only applies to a project; a SAL module has no data product to deploy")
ErrIaCWithSalModule is returned when --with-iac is passed with --salmodule, since the configuration deploys a data product and a module has none.
View Source
var ErrSkillsFlags = errors.New("--skills and --no-skills cannot both be given")
ErrSkillsFlags is returned when --skills and --no-skills are both passed.
View Source
var ErrUIWithoutSalModule = errors.New("--ui and --no-ui only apply with --salmodule; the form writes a SAL module's ontology.jsonld")
ErrUIWithoutSalModule is returned when --ui or --no-ui is passed without --salmodule, since the form only writes a module's ontology.
Functions ¶
This section is empty.
Types ¶
type InitCmd ¶
type InitCmd struct {
Description string `arg:"--description" help:"a sentence or two describing the project, recorded in .sal/config.jsonld; asked for when not given"`
SalModule bool `arg:"--salmodule" help:"also scaffold the files a SAL module needs: ontology.jsonld, Dockerfile, and .dockerignore"`
Bare bool `arg:"--bare" help:"with --salmodule, answer no questions and leave the task class blank"`
UI bool `` /* 166-byte string literal not displayed */
NoUI bool `arg:"--no-ui" help:"with --salmodule, answer the questions at the prompt instead of opening the browser form"`
WithIaC bool `` /* 147-byte string literal not displayed */
Skills bool `` /* 188-byte string literal not displayed */
NoSkills bool `arg:"--no-skills" help:"do not install the SAL agent skills"`
NoVocabularies bool `` /* 153-byte string literal not displayed */
}
Click to show internal directories.
Click to hide internal directories.