pkg.re/essentialkaos/ek@v12.36.0+incompatible/README.md (about)

     1  <p align="center"><a href="#readme"><img src="https://gh.kaos.st/go-ek.svg"/></a></p>
     2  
     3  <p align="center">
     4    <a href="https://kaos.sh/g/ek.v12?docs"><img src="https://gh.kaos.st/godoc.svg" alt="PkgGoDev"></a>
     5    <a href="https://kaos.sh/r/ek"><img src="https://kaos.sh/r/ek.svg" alt="GoReportCard" /></a>
     6    <a href="https://kaos.sh/b/ek"><img src="https://kaos.sh/b/3649d737-e5b9-4465-9765-b9f4ebec60ec.svg" alt="Codebeat badge" /></a>
     7    <a href="https://kaos.sh/w/ek/ci"><img src="https://kaos.sh/w/ek/ci.svg" alt="GitHub Actions CI Status" /></a>
     8    <a href="https://kaos.sh/w/ek/codeql"><img src="https://kaos.sh/w/ek/codeql.svg" alt="GitHub Actions CodeQL Status" /></a>
     9    <a href="#license"><img src="https://gh.kaos.st/apache2.svg" /></a>
    10  </p>
    11  
    12  <p align="center"><a href="#platform-support">Platform support</a> • <a href="#installation">Installation</a> • <a href="#sub-packages">Sub-packages</a> • <a href="#projects-with-ek">Projects with EK</a> • <a href="#build-status">Build Status</a> • <a href="#contributing">Contributing</a> • <a href="#license">License</a></p>
    13  
    14  <br/>
    15  
    16  Auxiliary packages for Go.
    17  
    18  ### Platform support
    19  
    20  Currently we support Linux and macOS (except `system` package). Some packages have stubs for Windows (_for autocomplete_).
    21  
    22  ### Installation
    23  
    24  Make sure you have a working Go 1.16+ workspace (_[instructions](https://golang.org/doc/install)_), then:
    25  
    26  ```
    27  go get pkg.re/essentialkaos/ek.v12
    28  ```
    29  
    30  If you want to update `EK` to latest stable release, do:
    31  
    32  ```
    33  go get -u pkg.re/essentialkaos/ek.v12
    34  ```
    35  
    36  ### Sub-packages
    37  
    38  * [`ansi`](https://pkg.re/essentialkaos/ek.v12/ansi?docs) - Package provides methods for working with ANSI/VT100 control sequences
    39  * [`cache`](https://pkg.re/essentialkaos/ek.v12/cache?docs) - Package provides a simple in-memory key:value cache
    40  * [`color`](https://pkg.re/essentialkaos/ek.v12/color?docs) - Package provides methods for working with colors
    41  * [`cron`](https://pkg.re/essentialkaos/ek.v12/cron?docs) - Package provides methods for working with cron expressions
    42  * [`csv`](https://pkg.re/essentialkaos/ek.v12/csv?docs) - Package with simple (without any checks) CSV parser compatible with default Go parser
    43  * [`easing`](https://pkg.re/essentialkaos/ek.v12/easing?docs) - Package with easing functions (Back, Bounce, Circ, Cubic, Elastic, Expo, Linear, Quad, Quint, Sine)
    44  * [`emoji`](https://pkg.re/essentialkaos/ek.v12/emoji?docs) - Package provides methods for working with emojis
    45  * [`env`](https://pkg.re/essentialkaos/ek.v12/env?docs) - Package provides methods for working with environment variables
    46  * [`errutil`](https://pkg.re/essentialkaos/ek.v12/errutil?docs) - Package provides methods for working with errors
    47  * [`events`](https://pkg.re/essentialkaos/ek.v12/events?docs) - Package provides methods and structs for creating event-driven systems
    48  * [`directio`](https://pkg.re/essentialkaos/ek.v12/directio?docs) - Package provides methods for reading/writing files with direct io
    49  * [`fmtc`](https://pkg.re/essentialkaos/ek.v12/fmtc?docs) - Package provides methods similar to fmt for colored output
    50  * [`fmtc/lscolors`](https://pkg.re/essentialkaos/ek.v12/fmtc/lscolors?docs) - Package provides methods for colorizing file names based on colors from dircolors
    51  * [`fmtutil`](https://pkg.re/essentialkaos/ek.v12/fmtutil?docs) - Package provides methods for output formatting
    52  * [`fmtutil/table`](https://pkg.re/essentialkaos/ek.v12/fmtutil/table?docs) - Package contains methods and structs for rendering data in tabular format
    53  * [`fsutil`](https://pkg.re/essentialkaos/ek.v12/fsutil?docs) - Package provides methods for working with files on POSIX compatible systems (BSD/Linux/macOS)
    54  * [`hash`](https://pkg.re/essentialkaos/ek.v12/hash?docs) - Package hash contains different hash algorithms and utilities
    55  * [`httputil`](https://pkg.re/essentialkaos/ek.v12/httputil?docs) - Package provides methods for working with HTTP request/responses
    56  * [`initsystem`](https://pkg.re/essentialkaos/ek.v12/initsystem?docs) - Package provides methods for working with different init systems (sysv, upstart, systemd)
    57  * [`jsonutil`](https://pkg.re/essentialkaos/ek.v12/jsonutil?docs) - Package provides methods for working with JSON data
    58  * [`knf`](https://pkg.re/essentialkaos/ek.v12/knf?docs) - Package provides methods for working with configuration files in [KNF format](https://kaos.sh/knf-spec)
    59  * [`log`](https://pkg.re/essentialkaos/ek.v12/log?docs) - Package with an improved logger
    60  * [`mathutil`](https://pkg.re/essentialkaos/ek.v12/mathutil?docs) - Package provides some additional math methods
    61  * [`netutil`](https://pkg.re/essentialkaos/ek.v12/netutil?docs) - Package provides methods for working with network
    62  * [`options`](https://pkg.re/essentialkaos/ek.v12/options?docs) - Package provides methods for working with command-line options
    63  * [`passwd`](https://pkg.re/essentialkaos/ek.v12/passwd?docs) - Package contains methods for working with passwords
    64  * [`path`](https://pkg.re/essentialkaos/ek.v12/path?docs) - Package for working with paths (fully compatible with base path package)
    65  * [`pid`](https://pkg.re/essentialkaos/ek.v12/pid?docs) - Package for working with PID files
    66  * [`pluralize`](https://pkg.re/essentialkaos/ek.v12/pluralize?docs) - Package provides methods for pluralization
    67  * [`progress`](https://pkg.re/essentialkaos/ek.v12/progress?docs) - Package provides methods and structs for creating terminal progress bar
    68  * [`rand`](https://pkg.re/essentialkaos/ek.v12/rand?docs) - Package for generating random data
    69  * [`req`](https://pkg.re/essentialkaos/ek.v12/req?docs) - Package simplify working with an HTTP requests
    70  * [`secstr`](https://pkg.re/essentialkaos/ek.v12/secstr?docs) - Package provides methods and structs for working with protected (secure) strings
    71  * [`signal`](https://pkg.re/essentialkaos/ek.v12/signal?docs) - Package provides methods for handling POSIX signals
    72  * [`sliceutil`](https://pkg.re/essentialkaos/ek.v12/sliceutil?docs) - Package provides methods for working with slices
    73  * [`sortutil`](https://pkg.re/essentialkaos/ek.v12/sortutil?docs) - Package provides methods for sorting slices
    74  * [`spellcheck`](https://pkg.re/essentialkaos/ek.v12/spellcheck?docs) - Package provides spellcheck based on Damerau–Levenshtein distance algorithm
    75  * [`spinner`](https://pkg.re/essentialkaos/ek.v12/spinner?docs) - Package provides methods for creating spinner animation for long-running tasks
    76  * [`strutil`](https://pkg.re/essentialkaos/ek.v12/strutil?docs) - Package provides methods for working with strings
    77  * [`system/exec`](https://pkg.re/essentialkaos/ek.v12/system/exec?docs) - Package provides methods for executing commands
    78  * [`system/process`](https://pkg.re/essentialkaos/ek.v12/system/process?docs) - Package provides methods for gathering information about active processes
    79  * [`system/procname`](https://pkg.re/essentialkaos/ek.v12/system/procname?docs) - Package provides methods for changing process name in the process tree
    80  * [`system/sensors`](https://pkg.re/essentialkaos/ek.v12/system/sensors?docs) - Package provide methods for collecting sensors information
    81  * [`system`](https://pkg.re/essentialkaos/ek.v12/system?docs) - Package provides methods for working with system data (metrics/users)
    82  * [`terminal`](https://pkg.re/essentialkaos/ek.v12/terminal?docs) - Package provides methods for working with user input
    83  * [`terminal/window`](https://pkg.re/essentialkaos/ek.v12/terminal/window?docs) - Package provides methods for working terminal window
    84  * [`timeutil`](https://pkg.re/essentialkaos/ek.v12/timeutil?docs) - Package provides methods for working with time and date
    85  * [`tmp`](https://pkg.re/essentialkaos/ek.v12/tmp?docs) - Package provides methods for working with temporary data
    86  * [`usage`](https://pkg.re/essentialkaos/ek.v12/usage?docs) - Package usage provides methods and structs for generating usage info for command-line tools
    87  * [`usage/update`](https://pkg.re/essentialkaos/ek.v12/usage/update?docs) - Package contains update checkers for different services
    88  * [`usage/completion/bash`](https://pkg.re/essentialkaos/ek.v12/usage/completion/bash?docs) - Package provides methods for generating bash completion
    89  * [`usage/completion/fish`](https://pkg.re/essentialkaos/ek.v12/usage/completion/fish?docs) - Package provides methods for generating fish completion
    90  * [`usage/completion/zsh`](https://pkg.re/essentialkaos/ek.v12/usage/completion/zsh?docs) - Package provides methods for generating zsh completion
    91  * [`uuid`](https://pkg.re/essentialkaos/ek.v12/uuid?docs) - Package provides methods for generating version 4 and 5 UUID's
    92  * [`version`](https://pkg.re/essentialkaos/ek.v12/version?docs) - Package version provides methods for working with semver version info
    93  
    94  ### Projects with `EK`
    95  
    96  * [aligo](https://kaos.sh/aligo) - Utility for checking and viewing Golang struct alignment info
    97  * [Bastion](https://kaos.sh/bastion) - Utility for temporary disabling access to server
    98  * [bibop](https://kaos.sh/bibop) - Utility for testing command-line tools
    99  * [bop](https://kaos.sh/bop) - Utility for generating bibop tests for RPM packages
   100  * [Deadline](https://kaos.sh/deadline) - Simple utility for controlling application working time
   101  * [fz](https://kaos.sh/fz) - Simple tool for formatting `go-fuzz` output
   102  * [GoHeft](https://kaos.sh/goheft) - Utility for listing sizes of all used static libraries compiled into golang binary
   103  * [GoMakeGen](https://kaos.sh/gomakegen) - Utility for generating makefiles for golang applications
   104  * [icecli](https://kaos.sh/icecli) - Command-line tools for Icecast
   105  * [IMC](https://kaos.sh/imc) - Simple terminal dashboard for Icecast
   106  * [init-exporter](https://github.com/funbox/init-exporter) - Utility for exporting services described by Procfile to init system
   107  * [jira-reindex-runner](https://kaos.sh/jira-reindex-runner) - Application for periodical running Jira re-index process
   108  * [knf](https://kaos.sh/knf) - Simple utility for reading values from KNF files
   109  * [MDToc](https://kaos.sh/mdtoc) - Utility for generating table of contents for markdown files
   110  * [Mockka](https://kaos.sh/mockka) - Mockka is a simple utility for mocking HTTP API's
   111  * [perfecto](https://kaos.sh/perfecto) - Tool for checking perfectly written RPM specs
   112  * [pkg.re Morpher](https://kaos.sh/pkgre) - Part of [pkg.re](https://pkg.re) service (_provides versioned URLs for Go_)
   113  * [RBInstall](https://kaos.sh/rbinstall) - Utility for installing prebuilt ruby to RBEnv
   114  * [Redis CLI Monitor](https://kaos.sh/redis-cli-monitor) - Tiny redis client for renamed MONITOR commands
   115  * [Redis Latency Monitor](https://kaos.sh/redis-latency-monitor) - Tiny Redis client for latency measurement
   116  * [Redis Monitor Top](https://kaos.sh/redis-monitor-top) - Tiny Redis client for aggregating stats from MONITOR flow
   117  * [rsz](https://kaos.sh/rsz) - Simple utility for image resizing
   118  * [scratch](https://kaos.sh/scratch) - Simple utility for generating blank files for Go apps, utilities and packages
   119  * [SHDoc](https://kaos.sh/shdoc) - Tool for viewing and exporting docs for shell scripts
   120  * [Sonar](https://kaos.sh/sonar) - Utility for showing user Slack status in Atlassian Jira
   121  * [SourceIndex](https://kaos.sh/source-index) - Utility for generating an index for source archives
   122  * [SSLScan Client](https://kaos.sh/sslcli) - Pretty awesome command-line client for public SSLLabs API
   123  * [swptop](https://kaos.sh/swptop) - Simple utility for viewing swap consumption of processes
   124  * [uc](https://kaos.sh/uc) - Simple utility for counting unique lines
   125  * [updown-badge-server](https://kaos.sh/updown-badge-server) - Service for generating badges for updown.io checks
   126  * [Yo](https://kaos.sh/yo) - Command-line YAML processor
   127  
   128  ### Build Status
   129  
   130  | Branch | Status |
   131  |--------|----------|
   132  | `master` | [![CI](https://kaos.sh/w/ek/ci.svg?branch=master)](https://kaos.sh/w/ek/ci?query=branch:master) |
   133  | `develop` | [![CI](https://kaos.sh/w/ek/ci.svg?branch=develop)](https://kaos.sh/w/ek/ci?query=branch:develop) |
   134  
   135  ### Contributing
   136  
   137  Before contributing to this project please read our [Contributing Guidelines](https://github.com/essentialkaos/contributing-guidelines#contributing-guidelines).
   138  
   139  ### License
   140  
   141  [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0)
   142  
   143  <p align="center"><a href="https://essentialkaos.com"><img src="https://gh.kaos.st/ekgh.svg"/></a></p>