Skip to content

Commit 956407f

Browse files
SimonSchubertSimonSchubert
committed
Add commands
1 parent 4629a93 commit 956407f

69 files changed

Lines changed: 6966 additions & 7 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.run/ConsoleApplicationKt.run.xml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="ConsoleApplicationKt" type="JetRunConfigurationType" nameIsGenerated="true">
3+
<option name="MAIN_CLASS_NAME" value="com.linuxcommandlibrary.cli.ConsoleApplicationKt" />
4+
<module name="Linux_Command_Library.cli.main" />
5+
<shortenClasspath name="NONE" />
6+
<method v="2">
7+
<option name="Make" enabled="true" />
8+
</method>
9+
</configuration>
10+
</component>

‎.run/FdroiInfoBuilderKt.run.xml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="FdroiInfoBuilderKt" type="JetRunConfigurationType" nameIsGenerated="true">
3+
<option name="MAIN_CLASS_NAME" value="com.linuxcommandlibrary.desktop.FdroiInfoBuilderKt" />
4+
<module name="Linux_Command_Library.websiteBuilder.main" />
5+
<shortenClasspath name="NONE" />
6+
<method v="2">
7+
<option name="Make" enabled="true" />
8+
</method>
9+
</configuration>
10+
</component>

‎.run/MarkdownBuilderKt.run.xml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="MarkdownBuilderKt" type="JetRunConfigurationType" nameIsGenerated="true">
3+
<option name="MAIN_CLASS_NAME" value="com.linuxcommandlibrary.desktop.MarkdownBuilderKt" />
4+
<module name="Linux_Command_Library.websiteBuilder.main" />
5+
<shortenClasspath name="NONE" />
6+
<method v="2">
7+
<option name="Make" enabled="true" />
8+
</method>
9+
</configuration>
10+
</component>

‎.run/WebsiteBuilderKt.run.xml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
<component name="ProjectRunConfigurationManager">
2+
<configuration default="false" name="WebsiteBuilderKt" type="JetRunConfigurationType" nameIsGenerated="true">
3+
<option name="MAIN_CLASS_NAME" value="com.linuxcommandlibrary.desktop.WebsiteBuilderKt" />
4+
<module name="Linux_Command_Library.websiteBuilder.main" />
5+
<shortenClasspath name="NONE" />
6+
<method v="2">
7+
<option name="Make" enabled="true" />
8+
</method>
9+
</configuration>
10+
</component>

‎README.md‎

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
![Icon](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandLibrary/master/art/web_hi_res_144.png)
44

5-
The app currently has **6219** manual pages, **23+** basic categories and a bunch of general terminal tips. It works 100% offline, doesn't need an internet connection and has no tracking software.
5+
The app currently has **6279** manual pages, **23+** basic categories and a bunch of general terminal tips. It works 100% offline, doesn't need an internet connection and has no tracking software.
66

77
[![Play Store](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandBibliotheca/master/art/play_store_badge.png)](https://play.google.com/store/apps/details?id=com.inspiredandroid.linuxcommandbibliotheca)
88
[![F-Droid](https://raw.githubusercontent.com/SimonSchubert/LinuxCommandBibliotheca/master/art/fdroid_badge.png)](https://f-droid.org/en/packages/com.inspiredandroid.linuxcommandbibliotheca/)
@@ -65,8 +65,6 @@ The source code is licensed under the Apache 2.0 license and the copyright of th
6565

6666
http://letsgokoyo.com - App Icon
6767

68-
https://www.commandlinefu.com - Lots of one-liners
69-
7068
https://icons8.com - Icons
7169

7270
https://tldr.sh - TLDR

‎assets/commands/ak.md‎

Lines changed: 104 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
# TLDR
2+
3+
**Start the server**
4+
5+
```ak server```
6+
7+
**Run database migrations**
8+
9+
```ak migrate```
10+
11+
**Create a superuser**
12+
13+
```ak createsuperuser```
14+
15+
**Export configuration**
16+
17+
```ak export_blueprint```
18+
19+
**Import a blueprint**
20+
21+
```ak import_blueprint [blueprint.yaml]```
22+
23+
**Generate a recovery key**
24+
25+
```ak create_recovery_key [username]```
26+
27+
**Show version**
28+
29+
```ak version```
30+
31+
**Run a worker process**
32+
33+
```ak worker```
34+
35+
# SYNOPSIS
36+
37+
**ak** _command_ [_options_]
38+
39+
# COMMANDS
40+
41+
**server**
42+
> Start the authentik web server.
43+
44+
**worker**
45+
> Start a background worker process.
46+
47+
**migrate**
48+
> Apply database migrations.
49+
50+
**createsuperuser**
51+
> Create an administrative user interactively.
52+
53+
**create_recovery_key** _user_ _duration_
54+
> Generate account recovery link.
55+
56+
**export_blueprint**
57+
> Export current configuration as blueprint YAML.
58+
59+
**import_blueprint** _file_
60+
> Import configuration from blueprint file.
61+
62+
**version**
63+
> Display version information.
64+
65+
**repair**
66+
> Run diagnostic and repair routines.
67+
68+
**shell**
69+
> Open interactive Python shell with authentik context.
70+
71+
**dbshell**
72+
> Open database shell.
73+
74+
# PARAMETERS
75+
76+
**--bind** _address_
77+
> Address for server to listen on.
78+
79+
**--help**
80+
> Display help information.
81+
82+
# DESCRIPTION
83+
84+
**ak** is the command-line interface for authentik, an open-source identity provider. It manages the authentik server, workers, database operations, and configuration import/export.
85+
86+
The **server** command starts the web interface and API server. Background tasks like email sending and LDAP synchronization require a **worker** process running separately.
87+
88+
Blueprints provide declarative configuration management. Export configurations with **export_blueprint** for version control or migration, and apply them with **import_blueprint**.
89+
90+
For account recovery when users are locked out, **create_recovery_key** generates a time-limited recovery URL. This requires access to the server command line.
91+
92+
authentik supports various authentication protocols including SAML, OAuth2/OIDC, LDAP, SCIM, and proxy authentication for applications that don't support SSO natively.
93+
94+
# CAVEATS
95+
96+
Requires Python environment with authentik installed. Database must be configured and accessible. Most administrative tasks are performed through the web interface; CLI is primarily for server operations and emergency recovery.
97+
98+
# HISTORY
99+
100+
authentik was created by **Jens Langhammer** and first released in **2020** as a modern alternative to older identity providers. Built with Django and designed for containerized deployments, it provides comprehensive identity management features. The project gained popularity as a self-hosted alternative to commercial identity providers, offering features like application proxying, multi-factor authentication, and extensive protocol support.
101+
102+
# SEE ALSO
103+
104+
[authelia](/man/authelia)(1), [keycloak](/man/keycloak)(1), [vault](/man/vault)(1)

‎assets/commands/anthropic.md‎

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
# TLDR
2+
3+
**Send a simple message** to Claude
4+
5+
```anthropic -g user "Hello, Claude!"```
6+
7+
**Send a message** with a specific model
8+
9+
```anthropic -g user "[prompt]" -m [claude-3-5-sonnet-20241022]```
10+
11+
**Analyze an image** with Claude
12+
13+
```anthropic -g user "Describe this image" -i [path/to/image.png]```
14+
15+
**Set a system prompt** for context
16+
17+
```anthropic -g user "[prompt]" -s "You are a helpful coding assistant"```
18+
19+
**Multi-turn conversation** with assistant response
20+
21+
```anthropic -g user "Hello!" -g assistant "Hi there!" -g user "How are you?"```
22+
23+
**Control response length** and randomness
24+
25+
```anthropic -g user "[prompt]" -x [2048] -t [0.7]```
26+
27+
# SYNOPSIS
28+
29+
**anthropic** [**-g** _role_ _content_] [**-m** _model_] [**-s** _system_] [**-i** _image_] [**-t** _temp_] [**-x** _tokens_]
30+
31+
# PARAMETERS
32+
33+
**-g**, **--message** _role_ _content_
34+
> Add a message with the specified role (user/assistant) and content. Can be repeated for multi-turn conversations.
35+
36+
**-m**, **--model** _model_
37+
> Specify the Claude model to use. Default: claude-3-opus-20240229.
38+
39+
**-s**, **--system** _prompt_
40+
> System message providing context or instructions for the conversation.
41+
42+
**-i**, **--image** _path_
43+
> Path to an image file (PNG, JPEG, or PDF) for vision tasks.
44+
45+
**-t**, **--temperature** _value_
46+
> Controls response randomness. Higher values produce more creative outputs.
47+
48+
**-k**, **--top_k** _value_
49+
> Restricts sampling to the top k most likely tokens.
50+
51+
**-p**, **--top_p** _value_
52+
> Nucleus sampling; restricts to tokens with cumulative probability above threshold.
53+
54+
**-x**, **--max_tokens** _count_
55+
> Maximum number of tokens in the response. Default: 1024.
56+
57+
# DESCRIPTION
58+
59+
**anthropic** is a command-line interface for interacting with Anthropic's Claude AI models. It provides direct access to the Claude API from the terminal, allowing users to send text messages and images for analysis.
60+
61+
The tool supports multi-turn conversations by chaining multiple **-g** flags, enabling context-aware interactions. It handles various image formats including PNG, JPEG, and PDF files for vision tasks. The CLI integrates well with shell pipelines, making it useful for scripting and automation workflows.
62+
63+
# CAVEATS
64+
65+
Requires an **ANTHROPIC_API_KEY** environment variable to be set with valid API credentials. PDF processing requires the **Poppler** library to be installed on the system. API usage incurs costs based on token consumption.
66+
67+
# HISTORY
68+
69+
The anthropic-cli tool was developed as a community project to provide command-line access to Anthropic's Claude models. It leverages the official Anthropic Python SDK and was created to fill the gap for developers preferring terminal-based workflows over web interfaces.
70+
71+
# SEE ALSO
72+
73+
[claude](/man/claude)(1), [ollama](/man/ollama)(1), [llm](/man/llm)(1)

‎assets/commands/authelia.md‎

Lines changed: 118 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,118 @@
1+
# TLDR
2+
3+
**Validate configuration file**
4+
5+
```authelia validate-config --config [config.yml]```
6+
7+
**Generate password hash**
8+
9+
```authelia crypto hash generate argon2```
10+
11+
**Generate random secret**
12+
13+
```authelia crypto rand --length [64]```
14+
15+
**Generate RSA keypair**
16+
17+
```authelia crypto pair rsa generate```
18+
19+
**Generate TOTP secret**
20+
21+
```authelia crypto totp generate --issuer [MyApp]```
22+
23+
**Hash a password interactively**
24+
25+
```authelia crypto hash generate argon2 --password```
26+
27+
**Show version**
28+
29+
```authelia --version```
30+
31+
**Run the server**
32+
33+
```authelia --config [/etc/authelia/config.yml]```
34+
35+
# SYNOPSIS
36+
37+
**authelia** [_global-options_] _command_ [_options_]
38+
39+
# COMMANDS
40+
41+
**crypto** hash|pair|rand|certificate|totp
42+
> Cryptographic utilities for generating secrets and hashes.
43+
44+
**validate-config**
45+
> Validate configuration file syntax and values.
46+
47+
**storage** migrate|schema-info|user|encryption
48+
> Database storage management and migrations.
49+
50+
**access-control** check-policy
51+
> Test access control rules against requests.
52+
53+
**build-info**
54+
> Display build information.
55+
56+
# CRYPTO SUBCOMMANDS
57+
58+
**crypto hash generate** argon2|pbkdf2|sha2crypt|bcrypt
59+
> Generate password hash using specified algorithm.
60+
61+
**crypto pair** rsa|ecdsa|ed25519
62+
> Generate cryptographic key pairs.
63+
64+
**crypto rand**
65+
> Generate random bytes or strings.
66+
67+
**crypto certificate** rsa|ecdsa|ed25519
68+
> Generate self-signed certificates.
69+
70+
**crypto totp generate**
71+
> Generate TOTP secret and QR code.
72+
73+
# PARAMETERS
74+
75+
**--config**, **-c** _path_
76+
> Path to configuration file(s).
77+
78+
**--password**
79+
> Read password interactively.
80+
81+
**--length** _n_
82+
> Length for random generation.
83+
84+
**--issuer** _name_
85+
> TOTP issuer name.
86+
87+
**--algorithm** _algo_
88+
> Hashing or encryption algorithm.
89+
90+
**--help**, **-h**
91+
> Display help information.
92+
93+
**--version**
94+
> Display version information.
95+
96+
# DESCRIPTION
97+
98+
**authelia** is the CLI for Authelia, an open-source authentication and authorization server. It provides multi-factor authentication and single sign-on for applications behind a reverse proxy.
99+
100+
The **crypto** commands generate secrets, password hashes, certificates, and TOTP configurations needed for Authelia setup. Use **crypto hash generate argon2** to create password hashes for the user database.
101+
102+
Configuration validation with **validate-config** checks YAML syntax and setting values before deployment. This catches common configuration errors.
103+
104+
The **storage** commands manage the user database, including migrations between versions and encryption key rotation. Authelia stores user credentials, TOTP secrets, and session data.
105+
106+
Authelia integrates with reverse proxies like Nginx, Traefik, and HAProxy to protect web applications with authentication portals and access policies.
107+
108+
# CAVEATS
109+
110+
Authelia runs as a service behind a reverse proxy; the CLI is for configuration and utilities. Requires proper reverse proxy configuration for authentication flow. User database and session storage must be configured. Some features require Redis for session storage in HA deployments.
111+
112+
# HISTORY
113+
114+
Authelia was created by **Clement Michaud** in **2016** as a simple authentication portal. The project evolved to support multiple second-factor methods (TOTP, WebAuthn, Duo) and advanced access control. Version 4 brought major architectural improvements and became widely adopted for self-hosted authentication. The project emphasizes security, privacy, and ease of deployment with container-first design.
115+
116+
# SEE ALSO
117+
118+
[authentik](/man/authentik)(1), [keycloak](/man/keycloak)(1), [nginx](/man/nginx)(1), [traefik](/man/traefik)(1)

0 commit comments

Comments
 (0)