ek

package module
v12.120.0 Latest Latest
Warning

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

 Go to latest Published: Apr 29, 2024 License: Apache-2.0 Imports: 3 Imported by: 0

README

PkgGoDev GoReportCard Code Climate Maintainability Codebeat badge
GitHub Actions CI Status GitHub Actions CodeQL Status

Platform support • Installation • Sub-packages • Projects with EK • CI Status • Contributing • License


Auxiliary packages for Go.

Platform support

Currently we support Linux and macOS (except some packages). All packages have stubs for unsupported platforms (for autocomplete).

[!NOTE] Some packages cannot be used on some platforms, such as the fsutil package, which cannot be used on Windows because it uses syscalls, or system subpackages that require procfs. But you can still write code on these platforms, because almost all packages have stubs with information about all the constants, variables, and functions available on other platforms. For example, Sublime with LSP on Windows will show all the information about methods that are only available on the Linux platform. All stub descriptions contain the ❗ symbol at the beginning to indicate unsupported code. Code with stubs can be compiled, but any method call from stubs will cause panic.

Installation

Make sure you have a working Go 1.20+ workspace (instructions), then:

go get github.com/essentialkaos/ek/v12

If you want to update ek to latest stable release, do:

go get -u github.com/essentialkaos/ek/v12

[!TIP] If you are using SublimeText 4 (4075+), we strongly recommend that you install extended Go syntax highlighting with support for fmtc tags.

Sub-packages

  • ansi — Package provides methods for working with ANSI/VT100 control sequences
  • cache — Package provides a simple in-memory key:value cache
  • color — Package provides methods for working with colors
  • cron — Package provides methods for working with cron expressions
  • csv — Package with simple (without any checks) CSV parser compatible with default Go parser
  • easing — Package with easing functions (Back, Bounce, Circ, Cubic, Elastic, Expo, Linear, Quad, Quint, Sine)
  • emoji — Package provides methods for working with emojis
  • env — Package provides methods for working with environment variables
  • errutil — Package provides methods for working with errors
  • events — Package provides methods and structs for creating event-driven systems
  • directio — Package provides methods for reading/writing files with direct io
  • fmtc — Package provides methods similar to fmt for colored output
  • fmtutil — Package provides methods for output formatting
  • fmtutil/barcode — Package provides methods to generate colored representation of unique data
  • fmtutil/panel — Package contains methods for rendering panels with text
  • fmtutil/table — Package contains methods and structs for rendering data in tabular format
  • fsutil — Package provides methods for working with files on POSIX compatible systems (BSD/Linux/macOS)
  • hash — Package hash contains different hash algorithms and utilities
  • httputil — Package provides methods for working with HTTP request/responses
  • initsystem — Package provides methods for working with different init systems (sysv, upstart, systemd)
  • jsonutil — Package provides methods for working with JSON data
  • knf — Package provides methods for working with configuration files in KNF format
  • knf/united — Package provides united configuration (knf + options + environment variables)
  • log — Package with an improved logger
  • lock — Package provides methods for working with lock files
  • lscolors — Package provides methods for colorizing file names based on colors from dircolors
  • mathutil — Package provides some additional math methods
  • netutil — Package provides methods for working with network
  • options — Package provides methods for working with command-line options
  • pager — Package provides methods for pager setup (more/less)
  • passthru — Package provides Reader and Writer with information about the amount of data being passed
  • passwd — Package contains methods for working with passwords
  • path — Package for working with paths (fully compatible with base path package)
  • pid — Package for working with PID files
  • pluralize — Package provides methods for pluralization
  • progress — Package provides methods and structs for creating terminal progress bar
  • protip — Package for displaying usage tips
  • rand — Package for generating random data
  • req — Package simplify working with an HTTP requests
  • secstr — Package provides methods and structs for working with protected (secure) strings
  • signal — Package provides methods for handling POSIX signals
  • sliceutil — Package provides methods for working with slices
  • sortutil — Package provides methods for sorting slices
  • spellcheck — Package provides spellcheck based on Damerau–Levenshtein distance algorithm
  • spinner — Package provides methods for creating spinner animation for long-running tasks
  • strutil — Package provides methods for working with strings
  • support — Package provides methods for collecting and printing support information about system
  • system/container — Package provides methods for checking container engine info
  • system/exec — Package provides methods for executing commands
  • system/process — Package provides methods for gathering information about active processes
  • system/procname — Package provides methods for changing process name in the process tree
  • system/sensors — Package provide methods for collecting sensors information
  • system — Package provides methods for working with system data (metrics/users)
  • terminal — Package provides methods for printing messages to terminal
  • terminal/input — Package provides methods for working with user input
  • terminal/tty — Package provides methods for working with TTY
  • timeutil — Package provides methods for working with time and date
  • tmp — Package provides methods for working with temporary data
  • usage — Package usage provides methods and structs for generating usage info for command-line tools
  • usage/update — Package contains update checkers for different services
  • usage/completion/bash — Package provides methods for generating bash completion
  • usage/completion/fish — Package provides methods for generating fish completion
  • usage/completion/zsh — Package provides methods for generating zsh completion
  • uuid — Package provides methods for generating version 4 and 5 UUID's
  • version — Package version provides methods for working with semver version info

Projects with EK

  • aligo — Utility for checking and viewing Golang struct alignment info
  • artefactor — Utility for downloading artefacts from GitHub
  • atlassian-cloud-backuper — Tool for backuping Atlassian cloud services (Jira and Confluence)
  • Bastion — Utility for temporary disabling access to server
  • bibop — Utility for testing command-line tools
  • bop — Utility for generating bibop tests for RPM packages
  • Deadline — Simple utility for controlling application working time
  • fz — Simple tool for formatting go-fuzz output
  • GoHeft — Utility for listing sizes of all used static libraries compiled into golang binary
  • GoMakeGen — Utility for generating makefiles for golang applications
  • icecli — Command-line tools for Icecast
  • IMC — Simple terminal dashboard for Icecast
  • init-exporter — Utility for exporting services described by Procfile to init system
  • jira-reindex-runner — Application for periodical running Jira re-index process
  • knf — Simple utility for reading values from KNF files
  • MDToc — Utility for generating table of contents for markdown files
  • path — Dead simple tool for working with paths
  • perfecto — Tool for checking perfectly written RPM specs
  • RBInstall — Utility for installing prebuilt ruby to RBEnv
  • RDS — Tool for Redis orchestration
  • Redis CLI Monitor — Tiny redis client for renamed MONITOR commands
  • Redis Latency Monitor — Tiny Redis client for latency measurement
  • Redis Monitor Top — Tiny Redis client for aggregating stats from MONITOR flow
  • rep — YUM repository management utility
  • rsz — Simple utility for image resizing
  • scratch — Simple utility for generating blank files for Go apps, utilities and packages
  • SHDoc — Tool for viewing and exporting docs for shell scripts
  • Sonar — Utility for showing user Slack status in Atlassian Jira
  • SourceIndex — Utility for generating an index for source archives
  • SSLScan Client — Pretty awesome command-line client for public SSLLabs API
  • subdy — CLI for subdomain.center API
  • swptop — Simple utility for viewing swap consumption of processes
  • uc — Simple utility for counting unique lines
  • updown-badge-server — Service for generating badges for updown.io checks
  • yo — Command-line YAML processor

CI Status

Branch Status
master CI
develop CI

Contributing

Before contributing to this project please read our Contributing Guidelines.

License

Apache License, Version 2.0

Documentation

Overview

Package ek is a set of auxiliary packages

Index

Constants

View Source 
const VERSION = "12.120.0"

VERSION is current ek package version

Variables

This section is empty.

Functions

This section is empty.

Types

This section is empty.

Source Files

View all Source files

Directories

Path Synopsis
Package ansi provides methods for working with ANSI/VT100 control sequences
 Package ansi provides methods for working with ANSI/VT100 control sequences
Package cache provides a simple in-memory key:value cache
 Package cache provides a simple in-memory key:value cache
Package color provides methods for working with colors
 Package color provides methods for working with colors
Package cron provides methods for working with cron expressions
 Package cron provides methods for working with cron expressions
Package csv contains simple CSV parser
 Package csv contains simple CSV parser
Package directio provides methods for reading/writing files with direct io
 Package directio provides methods for reading/writing files with direct io
Package easing contains easing functions
 Package easing contains easing functions
Package emoji provides methods for working with emojis
 Package emoji provides methods for working with emojis
Package env provides methods for working with environment variables
 Package env provides methods for working with environment variables
Package errutil provides methods for working with errors
 Package errutil provides methods for working with errors
Package events provides methods and structs for creating event-driven systems
 Package events provides methods and structs for creating event-driven systems
Package fmtc provides methods similar to fmt for colored output
 Package fmtc provides methods similar to fmt for colored output
Package fmtutil provides methods for output formatting
 Package fmtutil provides methods for output formatting
barcode
Package barcode provides methods to generate colored representation of unique data
 Package barcode provides methods to generate colored representation of unique data
panel
Package panel provides methods for rendering panels with text
 Package panel provides methods for rendering panels with text
table
Package table contains methods and structs for rendering data in tabular format
 Package table contains methods and structs for rendering data in tabular format
Package fsutil provides methods for working with files on POSIX compatible systems
 Package fsutil provides methods for working with files on POSIX compatible systems
Package hash contains different hash algorithms and utilities
 Package hash contains different hash algorithms and utilities
Package httputil provides methods for working with HTTP request/responses
 Package httputil provides methods for working with HTTP request/responses
Package initsystem provides methods for working with different init systems
 Package initsystem provides methods for working with different init systems
Package jsonutil provides methods for working with JSON data
 Package jsonutil provides methods for working with JSON data
knf
Package knf provides methods for working with configuration files in KNF format
 Package knf provides methods for working with configuration files in KNF format
united
Package united provides KNF configuration extended by environment variables and options
 Package united provides KNF configuration extended by environment variables and options
validators
Package validators provides basic KNF validators
 Package validators provides basic KNF validators
validators/fs
Package fs provides KNF validators for checking file-system items
 Package fs provides KNF validators for checking file-system items
validators/network
Package network provides KNF validators for checking items related to network
 Package network provides KNF validators for checking items related to network
validators/regexp
Package regexp provides KNF validators with regular expressions
 Package regexp provides KNF validators with regular expressions
validators/system
Package system provides KNF validators for checking system items (user, groups, network interfaces)
 Package system provides KNF validators for checking system items (user, groups, network interfaces)
value
Package lock provides methods for working with lock files
 Package lock provides methods for working with lock files
Package log provides an improved logger
 Package log provides an improved logger
Package lscolors provides methods for colorizing file names based on colors from dircolors
 Package lscolors provides methods for colorizing file names based on colors from dircolors
Package mathutil provides some additional math methods
 Package mathutil provides some additional math methods
Package netutil provides methods for working with network
 Package netutil provides methods for working with network
Package options provides methods for working with command-line options
 Package options provides methods for working with command-line options
Package pager provides methods for pager setup (more/less)
 Package pager provides methods for pager setup (more/less)
Package passthru provides Reader and Writer with information about the amount of data being passed.
 Package passthru provides Reader and Writer with information about the amount of data being passed.
Package passwd contains methods for working with passwords
 Package passwd contains methods for working with passwords
Package path provides methods for working with paths (fully compatible with base path package)
 Package path provides methods for working with paths (fully compatible with base path package)
Package pid provides methods for working with PID files
 Package pid provides methods for working with PID files
Package pluralize provides methods for pluralization
 Package pluralize provides methods for pluralization
Package progress provides methods and structs for creating terminal progress bar
 Package progress provides methods and structs for creating terminal progress bar
Package protip provides methods for displaying usage tips
 Package protip provides methods for displaying usage tips
Package rand provides methods for generating random data
 Package rand provides methods for generating random data
Package req simplify working with an HTTP requests
 Package req simplify working with an HTTP requests
Package secstr provides methods and structs for working with protected (secure) strings
 Package secstr provides methods and structs for working with protected (secure) strings
Package signal provides methods for handling POSIX signals
 Package signal provides methods for handling POSIX signals
Package sliceutil provides methods for working with slices
 Package sliceutil provides methods for working with slices
Package sortutil provides methods for sorting slices
 Package sortutil provides methods for sorting slices
Package spellcheck provides spellcheck based on Damerau–Levenshtein distance algorithm
 Package spellcheck provides spellcheck based on Damerau–Levenshtein distance algorithm
Package spinner provides methods for creating spinner animation for long-running tasks
 Package spinner provides methods for creating spinner animation for long-running tasks
Package strutil provides methods for working with strings
 Package strutil provides methods for working with strings
Package support provides methods for collecting and printing support information about system.
 Package support provides methods for collecting and printing support information about system.
apps
Package apps provides methods for obtaining version information about various tools
 Package apps provides methods for obtaining version information about various tools
deps
Package pkgs provides methods for collecting information about used dependencies
 Package pkgs provides methods for collecting information about used dependencies
fs
Package pkgs provides methods for collecting information about filesystem
 Package pkgs provides methods for collecting information about filesystem
network
Package network provides methods for collecting information about machine network
 Package network provides methods for collecting information about machine network
pkgs
Package pkgs provides methods for collecting information about installed packages
 Package pkgs provides methods for collecting information about installed packages
services
Package services provides methods for collecting information about system services
 Package services provides methods for collecting information about system services
Package system provides methods for working with system data (metrics/users)
 Package system provides methods for working with system data (metrics/users)
container
Package container provides methods for checking container engine info
 Package container provides methods for checking container engine info
exec
Package exec provides methods for executing commands
 Package exec provides methods for executing commands
process
Package process provides methods for gathering information about active processes
 Package process provides methods for gathering information about active processes
procname
Package procname provides methods for changing process name in the process tree
 Package procname provides methods for changing process name in the process tree
sensors
Package sensors provide methods for collecting sensors information
 Package sensors provide methods for collecting sensors information
Package terminal provides methods for printing messages to terminal
 Package terminal provides methods for printing messages to terminal
input
Package input provides methods for reading user input
 Package input provides methods for reading user input
tty
Package tty provides methods for working with TTY
 Package tty provides methods for working with TTY
Package timeutil provides methods for working with time and date
 Package timeutil provides methods for working with time and date
Package tmp provides methods and structs for working with temporary data
 Package tmp provides methods and structs for working with temporary data
Package usage provides methods and structs for generating usage info for command-line tools
 Package usage provides methods and structs for generating usage info for command-line tools
completion/bash
Package bash provides methods for generating bash completion
 Package bash provides methods for generating bash completion
completion/fish
Package fish provides methods for generating fish completion
 Package fish provides methods for generating fish completion
completion/zsh
Package zsh provides methods for generating zsh completion
 Package zsh provides methods for generating zsh completion
man
Package man contains methods for man pages generation
 Package man contains methods for man pages generation
update
Package uuid contains methods for generating version 4 and 5 UUID's
 Package uuid contains methods for generating version 4 and 5 UUID's
Package version provides methods for working with semver version info
 Package version provides methods for working with semver version info

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.