README
¶
xp-clifford
xp-clifford (Crossplane CLI Framework for Resource Data Extraction) is a Go module for building CLI tools that export definitions of external resources as Crossplane provider managed resource definitions.
Documentation
- Overview
- Getting Started
- Exporting Resources
- Configuration Parameters
- Interactive Widgets
- Custom Subcommands
- Error Handling
- Parsing and Sanitization
- mkcontainer Package
Support, Feedback, Contributing
This project is open to feature requests/suggestions, bug reports etc. via GitHub issues. Contribution and feedback are encouraged and always welcome. For more information about how to contribute, the project structure, as well as additional contribution information, see our Contribution Guidelines.
Security / Disclosure
If you find any bug that may be a security problem, please follow our instructions at in our security policy on how to report it. Please do not create GitHub issues for security-related doubts or problems.
Code of Conduct
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone. By participating in this project, you agree to abide by its Code of Conduct at all times.
Licensing
Copyright 2026 SAP SE or an SAP affiliate company and xp-clifford contributors. Please see our LICENSE for copyright and license information. Detailed information including third-party components and their licensing/copyright information is available via the REUSE tool.
Directories
¶
| Path | Synopsis |
|---|---|
|
configparam
Package configparam defines the configuration parameters that a CLI tool can use.
|
Package configparam defines the configuration parameters that a CLI tool can use. |
|
export
Package export defines the export subcommand.
|
Package export defines the export subcommand. |
|
widget
Package widget supplies interactive CLI widgets.
|
Package widget supplies interactive CLI widgets. |
|
Package erratt provides enhanced Go errors with attributes and wrapping.
|
Package erratt provides enhanced Go errors with attributes and wrapping. |
|
examples
|
|
|
basic
command
This example demonstrates the simplest possible CLI implementation using the export CLI framework.
|
This example demonstrates the simplest possible CLI implementation using the export CLI framework. |
|
boolparam
command
|
|
|
configfile
command
|
|
|
configparams
command
This example demonstrates a CLI implementation with a subcommand using the export CLI framework.
|
This example demonstrates a CLI implementation with a subcommand using the export CLI framework. |
|
durationparam
command
|
|
|
erratt
command
|
|
|
export
command
This example demonstrates a CLI implementation with a basic export subcommand.
|
This example demonstrates a CLI implementation with a basic export subcommand. |
|
exportcomment
command
|
|
|
exportresource
command
This example demonstrates a CLI implementation with the `export` subcommand that generates test resource definitions when invoked.
|
This example demonstrates a CLI implementation with the `export` subcommand that generates test resource definitions when invoked. |
|
exportsingle
command
|
|
|
exportwarn
command
|
|
|
floatparam
command
|
|
|
intparam
command
|
|
|
intslice
command
|
|
|
intslicedynamic
command
|
|
|
intslicestatic
command
|
|
|
kubexport
command
|
|
|
loginsubcommand
command
|
|
|
loginsubcommandparam
command
|
|
|
multiinput
command
|
|
|
parsan
command
|
|
|
stringparam
command
|
|
|
stringslice
command
|
|
|
stringslicedynamic
command
|
|
|
stringslicestatic
command
|
|
|
subcommand
command
This example demonstrates a CLI implementation with a subcommand and command line flags using the export CLI framework.
|
This example demonstrates a CLI implementation with a subcommand and command line flags using the export CLI framework. |
|
textinput
command
|
|
|
verbose
command
|
|
|
Package mkcontainer provides thread-safe multi-key containers for storing and retrieving items indexed by multiple keys simultaneously.
|
Package mkcontainer provides thread-safe multi-key containers for storing and retrieving items indexed by multiple keys simultaneously. |
|
Package parsan is a string parser and sanitizer function.
|
Package parsan is a string parser and sanitizer function. |
|
Package yaml converts Kubernetes resources to YAML strings.
|
Package yaml converts Kubernetes resources to YAML strings. |