README
¶
nctl
nctl is the command-line interface for Nine's cloud platform.
It lets you manage applications, services, storage, and more from your terminal.
Resources
| Category | Resources |
|---|---|
| deplo.io | Applications, Builds, Releases, Configs |
| storage.nine.ch | PostgreSQL, MySQL, OpenSearch, KeyValueStore, Buckets, BucketUsers |
| infrastructure.nine.ch | Kubernetes Clusters, CloudVMs |
| networking.nine.ch | ServiceConnections |
| iam.nine.ch | APIServiceAccounts |
| management.nine.ch | Projects |
Installation
# If you have go already installed
go install github.com/ninech/nctl@latest
# Homebrew
brew install ninech/taps/nctl
# Debian/Ubuntu
echo "deb [trusted=yes] https://repo.nine.ch/deb/ /" | sudo tee /etc/apt/sources.list.d/repo.nine.ch.list
sudo apt-get update
sudo apt-get install nctl
# Fedora/RHEL
cat <<EOF > /etc/yum.repos.d/repo.nine.ch.repo
[repo.nine.ch]
name=Nine Repo
baseurl=https://repo.nine.ch/yum/
enabled=1
gpgcheck=0
EOF
dnf install nctl
# Arch
# Install yay: https://github.com/Jguer/yay#binary
yay --version
yay -S nctl-bin
# EGet
# Install eget https://github.com/zyedidia/eget
eget ninech/nctl
Binaries for macOS, Linux and Windows can be found on the releases page.
Getting Started
- Login to the API:
nctl auth login - Explore available commands:
nctl --help
For complete documentation, tutorials, and guides, visit docs.nine.ch/docs/nctl/.
Development
make # Build nctl
make test # Run tests
make lint # Run linters
make lint-fix # Run linters and fix issues
make update # Update dependencies
make clean # Remove built artifacts
License
Documentation
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package api provides the Kubernetes client and configuration for the nine.ch API.
|
Package api provides the Kubernetes client and configuration for the nine.ch API. |
|
config
Package config provides the nctl specific configuration stored in the kubeconfig.
|
Package config provides the nctl specific configuration stored in the kubeconfig. |
|
gitinfo
Package gitinfo provides a client to interact with the git information service to retrieve metadata about git repositories.
|
Package gitinfo provides a client to interact with the git information service to retrieve metadata about git repositories. |
|
log
Package log provides functionality to interact with the Nine logging API.
|
Package log provides functionality to interact with the Nine logging API. |
|
login
module
|
|
|
Package apply provides the implementation for the apply command, allowing users to apply resources from files.
|
Package apply provides the implementation for the apply command, allowing users to apply resources from files. |
|
Package auth provides commands for authentication and session management.
|
Package auth provides commands for authentication and session management. |
|
Package copy provides commands to copy resources.
|
Package copy provides commands to copy resources. |
|
Package create provides functionality to create resources in the nine.ch API.
|
Package create provides functionality to create resources in the nine.ch API. |
|
Package delete provides functionality to delete resources in the nine.ch API.
|
Package delete provides functionality to delete resources in the nine.ch API. |
|
Package edit provides functionality to edit resources in a text editor.
|
Package edit provides functionality to edit resources in a text editor. |
|
Package exec provides the implementation for the exec command.
|
Package exec provides the implementation for the exec command. |
|
Package get implements the get command.
|
Package get implements the get command. |
|
internal
|
|
|
application
Package application provides utility functions for interacting with Deploio applications.
|
Package application provides utility functions for interacting with Deploio applications. |
|
bucket
Package bucket provides utilities for managing buckets.
|
Package bucket provides utilities for managing buckets. |
|
format
Package format contains utilities for formatting and printing output, including support for spinners, colored YAML/JSON, and resource stripping.
|
Package format contains utilities for formatting and printing output, including support for spinners, colored YAML/JSON, and resource stripping. |
|
logbox
Package logbox provides a UI component to display logs with a spinner.
|
Package logbox provides a UI component to display logs with a spinner. |
|
test
Package test provides utilities and helpers for testing nctl.
|
Package test provides utilities and helpers for testing nctl. |
|
Package logs provides commands to retrieve and tail logs from deplo.io resources.
|
Package logs provides commands to retrieve and tail logs from deplo.io resources. |
|
Package predictor provides shell completion predictors for nctl resources.
|
Package predictor provides shell completion predictors for nctl resources. |
|
Package update contains the commands for updating resources.
|
Package update contains the commands for updating resources. |
Click to show internal directories.
Click to hide internal directories.