Skip to content

Commit

Permalink
Readme was a little out of date
Browse files Browse the repository at this point in the history
  • Loading branch information
scottbilas committed Apr 26, 2024
1 parent df7e6cd commit 0938aad
Showing 1 changed file with 27 additions and 8 deletions.
35 changes: 27 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,22 @@
# OkTools

These tools are ok.
Various small CLI tools and libraries bundled together for convenience.

[![validate](https://github.com/scottbilas/OkTools/actions/workflows/validate.yml/badge.svg)](https://github.com/scottbilas/OkTools/actions/workflows/validate.yml)

## Building

`dotnet build` should do it. Currently requires .NET 6. Only tested on Windows, and some tools will always be Windows-only (like okunity).
`dotnet build` should do it. Currently requires .NET 8 (7 in a couple cases). Only tested on Windows. There is some platform-specific

Perf testing: `dotnet run -c Release --project perftests/Core.PerfTests/Core.PerfTests.csproj -- --filter * --disasm --artifacts artifacts/perf/Core.PerfTests`

## okflog (Flog.Cli)
## OkTools.Core

TUI app. A progressive filtering `tail` + `less` for incremental analysis. Very early in development.

[CLI docs](src/Flog.Cli/FlogCli.docopt.txt)
A pile of useful C# utilities published as NuGet [package](https://www.nuget.org/packages/OkTools.Core/). I update this fairly regularly with new toys.

## loggo (Loggo.Cli)

A generator for log output. Nice for testing okflog. Finished.
A generator for log output. Nice for testing tools that sublaunch cli apps and redirect their stdin/out like a command shell. Finished, with occasional tweaks added.

[CLI docs](src/Loggo.Cli/LoggoCli.docopt.txt)

Expand All @@ -34,6 +32,27 @@ Symbolicator, query, and conversion tool for Process Monitor ([procmon](https://

Showkeys for Windows. Virtual terminal sequences. Useful when debugging TUI apps on Windows. Finished.

## stale (Stale.Cli)

A utility that will run cli apps, capture output, monitor, filter, show live status. I want to be able to have "sticky" error messages while a given build log or whatever continues to scroll.

[CLI docs](src/Stale.Cli/StaleCli.docopt.txt)

## okunity (Unity.Cli)

Toolkit of helpful stuff for working with Unity from the command line. Fairly stable.
Toolkit of helpful stuff for working with Unity from the command line. For example killing the Hub and prevent it from coming up automatically, or running Unity with a project-local timestamp-rotated log file. Fairly stable.

## On Pause

### lyfe (Lyfe.Cli)

I'm having trouble finding time to get this thing off the ground, but the idea is to have a basic machine process manager that looks at desired target state of hardware (like "long plane flight" or "docked at desk") and will start/stop system processes and services accordingly.

This is an attempt to deal with the general inability of Windows programmers to write background-run software that actually idles (0% CPU). I like my laptop battery going as far as possible and there are endless annoying but useful vampires I want to shift in and out.

### okflog (Flog.Cli)

TUI app. A progressive filtering `tail` + `less` for incremental analysis. On hold while I work on Stale.

[CLI docs](src/Flog.Cli/FlogCli.docopt.txt)

0 comments on commit 0938aad

Please sign in to comment.