Skip to content

Commit

Permalink
Merge pull request #58 from DannyBen/update/bashly
Browse files Browse the repository at this point in the history
Regenerate with bashly 1.2.7 pre-release
  • Loading branch information
DannyBen authored Dec 20, 2024
2 parents 22dac79 + d6950f2 commit a4d4caf
Show file tree
Hide file tree
Showing 24 changed files with 155 additions and 267 deletions.
271 changes: 76 additions & 195 deletions alf

Large diffs are not rendered by default.

30 changes: 16 additions & 14 deletions doc/alf-connect.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-connect" "1" "February 2024" "" "Connect to a remote git repository."
.TH "alf\-connect" "1" "December 2024" "" "Connect to a remote git repository."
.SH NAME
\f[B]alf connect\f[R] - Connect to a remote git repository.
\f[B]alf connect\f[R] \- Connect to a remote git repository.
.SH SYNOPSIS
\f[B]alf connect\f[R] REPO OPTIONS
.SH DESCRIPTION
Expand All @@ -16,31 +16,33 @@ Remote GitHub repository to connect to.
Can be one of:
.IP \[bu] 2
Your username on GitHub.
In this case, the repository is expected to be named \f[B]alf-conf\f[R].
In this case, the repository is expected to be named
\f[B]alf\-conf\f[R].
.IP \[bu] 2
Your username/repo on GitHub.
.IP \[bu] 2
Any other full URL to a repository.
.IP \[bu] 2
\f[I]Required\f[R]
.SH OPTIONS
.SS --ssh
Connect to GitHub non-interactively using SSH (implies \f[B]--yes\f[R]).
.SS --https
Connect to GitHub non-interactively using HTTPS (implies
\f[B]--yes\f[R]).
.SS --yes, -y
Connect to any remote repository non-interactively.
.SS \-\-ssh
Connect to GitHub non\-interactively using SSH (implies
\f[B]\-\-yes\f[R]).
.SS \-\-https
Connect to GitHub non\-interactively using HTTPS (implies
\f[B]\-\-yes\f[R]).
.SS \-\-yes, \-y
Connect to any remote repository non\-interactively.
.SH DEPENDENCIES
.SS git
.SH EXAMPLES
.IP
.EX
alf connect you --ssh
alf connect you \-\-ssh
alf connect you/alf-config
alf connect you/alf\-config
alf connect https://You\[at]bitbucket.org/YourUser/rush-repo.git --yes
alf connect https://You\[at]bitbucket.org/YourUser/rush\-repo.git \-\-yes
.EE
.SH SEE ALSO
\f[B]alf\f[R](1)
2 changes: 1 addition & 1 deletion doc/alf-connect.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-connect(1) | Connect to a remote git repository.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-download.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-download" "1" "February 2024" "" "Perform git pull on the connected repo."
.TH "alf\-download" "1" "December 2024" "" "Perform git pull on the connected repo."
.SH NAME
\f[B]alf download\f[R] - Perform git pull on the connected repo.
\f[B]alf download\f[R] \- Perform git pull on the connected repo.
.SH SYNOPSIS
\f[B]alf download\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-download.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-download(1) | Perform git pull on the connected repo.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-edit.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-edit" "1" "February 2024" "" "Open your \f[CR]alf.conf\f[R] for editing."
.TH "alf\-edit" "1" "December 2024" "" "Open your \f[CR]alf.conf\f[R] for editing."
.SH NAME
\f[B]alf edit\f[R] - Open your \f[CR]alf.conf\f[R] for editing.
\f[B]alf edit\f[R] \- Open your \f[CR]alf.conf\f[R] for editing.
.SH SYNOPSIS
\f[B]alf edit\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-edit.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-edit(1) | Open your `alf.conf` for editing.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-generate.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-generate" "1" "February 2024" "" "Generate aliases to stdout."
.TH "alf\-generate" "1" "December 2024" "" "Generate aliases to stdout."
.SH NAME
\f[B]alf generate\f[R] - Generate aliases to stdout.
\f[B]alf generate\f[R] \- Generate aliases to stdout.
.SH SYNOPSIS
\f[B]alf generate\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-generate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-generate(1) | Generate aliases to stdout.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-info.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-info" "1" "February 2024" "" "Show all alf related system facts."
.TH "alf\-info" "1" "December 2024" "" "Show all alf related system facts."
.SH NAME
\f[B]alf info\f[R] - Show all alf related system facts.
\f[B]alf info\f[R] \- Show all alf related system facts.
.SH SYNOPSIS
\f[B]alf info\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-info.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-info(1) | Show all alf related system facts.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
7 changes: 4 additions & 3 deletions doc/alf-save.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,9 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-save" "1" "February 2024" "" "Generate aliases to \f[CR]\[ti]/.bash_aliases\f[R]."
.TH "alf\-save" "1" "December 2024" "" "Generate aliases to \f[CR]\[ti]/.bash_aliases\f[R]."
.SH NAME
\f[B]alf save\f[R] - Generate aliases to \f[CR]\[ti]/.bash_aliases\f[R].
\f[B]alf save\f[R] \- Generate aliases to
\f[CR]\[ti]/.bash_aliases\f[R].
.SH SYNOPSIS
\f[B]alf save\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-save.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-save(1) | Generate aliases to `~/.bash_aliases`.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-upgrade.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-upgrade" "1" "February 2024" "" "Upgrade alf to the latest version."
.TH "alf\-upgrade" "1" "December 2024" "" "Upgrade alf to the latest version."
.SH NAME
\f[B]alf upgrade\f[R] - Upgrade alf to the latest version.
\f[B]alf upgrade\f[R] \- Upgrade alf to the latest version.
.SH SYNOPSIS
\f[B]alf upgrade\f[R]
.SH DESCRIPTION
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-upgrade.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-upgrade(1) | Upgrade alf to the latest version.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
6 changes: 3 additions & 3 deletions doc/alf-upload.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-upload" "1" "February 2024" "" "Perform git commit and push on the connected repo."
.TH "alf\-upload" "1" "December 2024" "" "Perform git commit and push on the connected repo."
.SH NAME
\f[B]alf upload\f[R] - Perform git commit and push on the connected
\f[B]alf upload\f[R] \- Perform git commit and push on the connected
repo.
.SH SYNOPSIS
\f[B]alf upload\f[R]
Expand Down
2 changes: 1 addition & 1 deletion doc/alf-upload.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-upload(1) | Perform git commit and push on the connected repo.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
8 changes: 4 additions & 4 deletions doc/alf-which.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf-which" "1" "February 2024" "" "Show the alias command."
.TH "alf\-which" "1" "December 2024" "" "Show the alias command."
.SH NAME
\f[B]alf which\f[R] - Show the alias command.
\f[B]alf which\f[R] \- Show the alias command.
.SH SYNOPSIS
\f[B]alf which\f[R] CODE SUBCODE
.SH DESCRIPTION
Expand All @@ -15,6 +15,6 @@ Show the command for this alias code.
.IP \[bu] 2
\f[I]Required\f[R]
.SS SUBCODE
Show the command for this alias sub-code.
Show the command for this alias sub\-code.
.SH SEE ALSO
\f[B]alf\f[R](1)
2 changes: 1 addition & 1 deletion doc/alf-which.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf-which(1) | Show the alias command.
%
% February 2024
% December 2024

NAME
==================================================
Expand Down
16 changes: 8 additions & 8 deletions doc/alf.1
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf" "1" "February 2024" "Version 0.6.1" "Your Little Bash Alias Friend"
.TH "alf" "1" "December 2024" "Version 0.6.1" "Your Little Bash Alias Friend"
.SH NAME
\f[B]alf\f[R] - Your Little Bash Alias Friend
\f[B]alf\f[R] \- Your Little Bash Alias Friend
.SH SYNOPSIS
\f[B]alf\f[R] COMMAND
.SH DESCRIPTION
Expand Down Expand Up @@ -30,14 +30,14 @@ Show all alf related system facts.
.SS ALF_RC_FILE
Path to alfrc file.
.PP
This file holds the path to the alf-conf repository.
This file holds the path to the alf\-conf repository.
.PP
Default: \f[B]\[ti]/.alfrc\f[R]
.SH SEE ALSO
\f[B]alf-connect\f[R](1), \f[B]alf-download\f[R](1),
\f[B]alf-upload\f[R](1), \f[B]alf-generate\f[R](1),
\f[B]alf-save\f[R](1), \f[B]alf-edit\f[R](1), \f[B]alf-which\f[R](1),
\f[B]alf-upgrade\f[R](1), \f[B]alf-info\f[R](1), \f[B]alf.conf\f[R](5)
\f[B]alf\-connect\f[R](1), \f[B]alf\-download\f[R](1),
\f[B]alf\-upload\f[R](1), \f[B]alf\-generate\f[R](1),
\f[B]alf\-save\f[R](1), \f[B]alf\-edit\f[R](1), \f[B]alf\-which\f[R](1),
\f[B]alf\-upgrade\f[R](1), \f[B]alf\-info\f[R](1), \f[B]alf.conf\f[R](5)
.SH SOURCE CODE
https://github.com/dannyben/alf
.SH ISSUE TRACKER
Expand Down
28 changes: 14 additions & 14 deletions doc/alf.conf.5
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
.\" Automatically generated by Pandoc 3.1.9
.\" Automatically generated by Pandoc 3.2
.\"
.TH "alf.conf" "5" "September 2023" "alf.conf(5)" "File Formats Manual"
.SH NAME
\f[B]alf.conf\f[R] - configuration file for alf
\f[B]alf.conf\f[R] \- configuration file for alf
.SH DESCRIPTION
The \f[B]alf.conf\f[R] file consists of aliases and the command
associated with them.
Expand All @@ -11,7 +11,7 @@ Any line that does not start with a whitespace is considered a base
alias.
.IP
.EX
dir: ls -l
dir: ls \-l
.EE
.SS Sub Aliases
Any line that starts with one or more whitespaces will be nested as a
Expand All @@ -22,8 +22,8 @@ nested commands.
.EX
g: git
s: status
c: add . --all && git commit -am
l: log --all --graph --date=relative
c: add . \-\-all && git commit \-am
l: log \-\-all \-\-graph \-\-date=relative
p: push
.EE
.PP
Expand All @@ -45,18 +45,18 @@ Sub commands that start with an exclamation mark will not be prefixed by
their base command.
.IP
.EX
dc: docker-compose
deploy: !docker stack deploy -c docker-compose.yml
upd: up -d
dc: docker\-compose
deploy: !docker stack deploy \-c docker\-compose.yml
upd: up \-d
.EE
.SS Virtual Command
When you do not need to prepend your sub aliases with the primary
command, specify an exclamation mark in the primary command.
.IP
.EX
dns: !
check: host -t ns
flush: sudo systemd-resolve --flush-caches
check: host \-t ns
flush: sudo systemd\-resolve \-\-flush\-caches
.EE
.PP
This example provides two completely different aliases: \f[B]dns
Expand All @@ -71,18 +71,18 @@ You can even provide a default value to the argument using the standard
bash syntax, and use any bash construct, like inline functions.
.IP
.EX
count: find ${1:-.} -type f | wc -l
binlink: sudo ln -fs \[dq]$(realpath $1)\[dq] \[dq]/usr/local/bin/$1\[dq]
count: find ${1:\-.} \-type f | wc \-l
binlink: sudo ln \-fs \[dq]$(realpath $1)\[dq] \[dq]/usr/local/bin/$1\[dq]
.EE
.SS Comments
Any line starting with \f[B]#\f[R] will be considered a comment.
Do not use inline comments.
.IP
.EX
# good
dir: ls -l
dir: ls \-l
dir: ls -l # bad
dir: ls \-l # bad
.EE
.SH SEE ALSO
\f[B]alf\f[R](1)
Expand Down
2 changes: 1 addition & 1 deletion doc/alf.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
% alf(1) Version 0.6.1 | Your Little Bash Alias Friend
% Danny Ben Shitrit \<https://github.com/dannyben\>
% February 2024
% December 2024

NAME
==================================================
Expand Down
2 changes: 1 addition & 1 deletion op.conf
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
## Script Generation

generate: bashly generate && op man
generate: bashly generate --env production && op man
#? Generate the script and manpage

watch: filewatcher --immediate "src/**/*.*" "bashly generate"
Expand Down
4 changes: 4 additions & 0 deletions settings.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
enable_view_markers: always
enable_env_var_names_array: never
enable_deps_array: never

usage_colors:
caption: bold
command: green
Expand Down

0 comments on commit a4d4caf

Please sign in to comment.