nctl

command module
v1.22.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 11, 2026 License: Apache-2.0 Imports: 9 Imported by: 0

README

nctl

CI Release Go Report Card License

nctl is the command-line interface for Nine's cloud platform. It lets you manage applications, services, storage, and more from your terminal.

Documentation

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

# Homebrew
# if you have brew >= 6 you will need to trust the formula
# brew trust --formula ninech/taps/nctl
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

  1. Login to the API: nctl auth login
  2. 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

Apache 2.0

Documentation

Overview

Package main is the entry point for nctl.

Directories

Path Synopsis
api
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.
internal/credential
Package credential stores secrets in the keyring of the operating system and falls back to files only the user can read where the keyring is unavailable.
Package credential stores secrets in the keyring of the operating system and falls back to files only the user can read where the keyring is unavailable.
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
internal
apifield
Package apifield defines known API field defaults and acceptable values for CLI flags.
Package apifield defines known API field defaults and acceptable values for CLI flags.
apiresource
Package apiresource resolves API resources and GVKs associated with CLI commands.
Package apiresource resolves API resources and GVKs associated with CLI commands.
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.
cli
cmd
Package cmd is the root of the nctl command tree.
Package cmd is the root of the nctl command tree.
cmd/apply
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.
cmd/auth
Package auth provides commands for authentication and session management.
Package auth provides commands for authentication and session management.
cmd/copy
Package copy provides commands to copy resources.
Package copy provides commands to copy resources.
cmd/create
Package create provides functionality to create resources in the nine.ch API.
Package create provides functionality to create resources in the nine.ch API.
cmd/delete
Package delete provides functionality to delete resources in the nine.ch API.
Package delete provides functionality to delete resources in the nine.ch API.
cmd/edit
Package edit provides functionality to edit resources in a text editor.
Package edit provides functionality to edit resources in a text editor.
cmd/exec
Package exec provides the implementation for the exec command.
Package exec provides the implementation for the exec command.
cmd/get
Package get implements the get command.
Package get implements the get command.
cmd/logs
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.
cmd/update
Package update contains the commands for updating resources.
Package update contains the commands for updating resources.
completion
Package completion configures shell completion predictors for the CLI.
Package completion configures shell completion predictors for the CLI.
flag
Package flag provides value types for kong flags which more than one command declares.
Package flag provides value types for kong flags which more than one command declares.
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.
ipcheck
Package ipcheck provides a client for detecting the caller's public IP address.
Package ipcheck provides a client for detecting the caller's public IP address.
kubeconfig
Package kubeconfig builds the kubeconfig entries nctl uses to talk to the Nine API and to Kubernetes clusters, and merges them into the user's kubeconfig.
Package kubeconfig builds the kubeconfig entries nctl uses to talk to the Nine API and to Kubernetes clusters, and merges them into the user's kubeconfig.
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.
serviceconnection
Package serviceconnection holds what the commands managing service connections share.
Package serviceconnection holds what the commands managing service connections share.
sshkey
Package sshkey reads SSH public keys from flags and files.
Package sshkey reads SSH public keys from flags and files.
testutil
Package testutil provides utilities and helpers for testing nctl.
Package testutil provides utilities and helpers for testing nctl.
waiter
Package waiter watches API objects until they reach a desired state, showing the progress with a spinner.
Package waiter watches API objects until they reach a desired state, showing the progress with a spinner.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL