Skip to content

Commit

Permalink
Merge pull request #613 from DannyBen/update/domain
Browse files Browse the repository at this point in the history
Update documentation domain to bashly.dev
  • Loading branch information
DannyBen authored Jan 23, 2025
2 parents 5567311 + d05605c commit d2a38fd
Show file tree
Hide file tree
Showing 23 changed files with 369 additions and 369 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Create feature-rich bash scripts using simple YAML configuration
[![Build Status](https://github.com/DannyBen/bashly/workflows/Test/badge.svg)](https://github.com/DannyBen/bashly/actions?query=workflow%3ATest)
[![Maintainability](https://api.codeclimate.com/v1/badges/8cf89047e50ca601e431/maintainability)](https://codeclimate.com/github/DannyBen/bashly/maintainability)

## [bashly.dannyb.co](https://bashly.dannyb.co)
## [bashly.dev](https://bashly.dev)

---

Expand Down Expand Up @@ -76,6 +76,6 @@ Visit the *[How to contribute][contributing]* page for more information.

[issues]: https://github.com/DannyBen/bashly/issues
[discussions]: https://github.com/DannyBen/bashly/discussions
[docs]: https://bashly.dannyb.co/
[docs]: https://bashly.dev/
[examples]: https://github.com/DannyBen/bashly/tree/master/examples#bashly-examples
[contributing]: https://github.com/DannyBen/bashly/blob/master/CONTRIBUTING.md#how-to-contribute
2 changes: 1 addition & 1 deletion bashly.gemspec
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ Gem::Specification.new do |s|
s.metadata = {
'bug_tracker_uri' => 'https://github.com/DannyBen/bashly/issues',
'changelog_uri' => 'https://github.com/DannyBen/bashly/blob/master/CHANGELOG.md',
'homepage_uri' => 'https://bashly.dannyb.co/',
'homepage_uri' => 'https://bashly.dev/',
'source_code_uri' => 'https://github.com/DannyBen/bashly',
'rubygems_mfa_required' => 'true',
}
Expand Down
2 changes: 1 addition & 1 deletion examples/internal-run/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ want to consider using [lib functions]
instead, for a more robust codebase.

While this pattern of calling run internally is supported, you may want to
consider using [lib functions](https://bashly.dannyb.co/usage/writing-your-scripts/#adding-common-functions)
consider using [lib functions](https://bashly.dev/usage/writing-your-scripts/#adding-common-functions)
instead. lib functions can help create a more robust and maintainable codebase
by centralizing reusable logic.

Expand Down
2 changes: 1 addition & 1 deletion lib/bashly/cli.rb
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ class CLI
def self.runner
runner = MisterBin::Runner.new version: Bashly::VERSION,
header: 'Bashly - Bash CLI Generator',
footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dannyb.co`"
footer: "Help: m`bashly COMMAND --help`\nDocs: bu`https://bashly.dev`"

runner.route 'init', to: Commands::Init
runner.route 'preview', to: Commands::Preview
Expand Down
16 changes: 8 additions & 8 deletions lib/bashly/docs/arg.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
arg:
help: Define positional arguments.
url: https://bashly.dannyb.co/configuration/argument/
url: https://bashly.dev/configuration/argument/
example: |-
args:
- name: user
Expand All @@ -16,7 +16,7 @@ arg:
arg.allowed:
help: Specify a list of allowed values. Can be used in conjunction with `default` and `required`.
url: https://bashly.dannyb.co/configuration/argument/#allowed
url: https://bashly.dev/configuration/argument/#allowed
example: |-
args:
- name: region
Expand All @@ -35,7 +35,7 @@ arg.allowed:
arg.default:
help: Specify the value to apply when not provided by the user.
url: https://bashly.dannyb.co/configuration/argument/#default
url: https://bashly.dev/configuration/argument/#default
example: |-
args:
- name: images
Expand All @@ -44,7 +44,7 @@ arg.default:
arg.help:
help: Specify the help message for this argument.
url: https://bashly.dannyb.co/configuration/argument/#help
url: https://bashly.dev/configuration/argument/#help
example: |-
args:
- name: user
Expand All @@ -53,7 +53,7 @@ arg.help:
arg.name:
help: Specify the lowercase name of the argument.
url: https://bashly.dannyb.co/configuration/argument/#name
url: https://bashly.dev/configuration/argument/#name
example: |-
args:
- name: user
Expand All @@ -67,7 +67,7 @@ arg.repeatable:
The argument below will be received as a space-delimited string which needs to be converted to an array with:
`eval "data=(${args[file]})"`
url: https://bashly.dannyb.co/configuration/argument/#repeatable
url: https://bashly.dev/configuration/argument/#repeatable
example: |-
args:
- name: file
Expand All @@ -77,7 +77,7 @@ arg.repeatable:
arg.required:
help: Specify that this argument is required.
url: https://bashly.dannyb.co/configuration/argument/#required
url: https://bashly.dev/configuration/argument/#required
example: |-
args:
- name: region
Expand All @@ -87,7 +87,7 @@ arg.required:
arg.validate:
help: Apply custom validation functions.

url: https://bashly.dannyb.co/configuration/argument/#validate
url: https://bashly.dev/configuration/argument/#validate
example: |-
args:
- name: path
Expand Down
46 changes: 23 additions & 23 deletions lib/bashly/docs/command.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
command:
help: Define the root command, or any sub-command.
url: https://bashly.dannyb.co/configuration/command/
url: https://bashly.dev/configuration/command/
example: |-
name: rush
help: Personal package manager
Expand All @@ -17,7 +17,7 @@ command:
command.alias:
help: Specify one or more aliases for this sub-command.
url: https://bashly.dannyb.co/configuration/command/#alias
url: https://bashly.dev/configuration/command/#alias
example: |-
# Define a single alias
command:
Expand All @@ -36,7 +36,7 @@ command.alias:
command.args:
help: Define a list of positional arguments. See `arg` for reference.
url: https://bashly.dannyb.co/configuration/command/#args
url: https://bashly.dev/configuration/command/#args
example: |-
args:
- name: repo
Expand All @@ -45,7 +45,7 @@ command.args:
command.catch_all:
help: Specify that this command should allow for additional arbitrary arguments or flags.
url: https://bashly.dannyb.co/configuration/command/#catch_all
url: https://bashly.dev/configuration/command/#catch_all
example: |-
commands:
- name: download
Expand All @@ -67,7 +67,7 @@ command.catch_all:
command.commands:
help: Define a list of sub-commands. See `command` for reference.
url: https://bashly.dannyb.co/configuration/command/#commands
url: https://bashly.dev/configuration/command/#commands
example: |-
commands:
- name: add
Expand All @@ -76,7 +76,7 @@ command.commands:
command.completions:
help: Specify a list of additional completion suggestions when used in conjunction with `bashly add completions`.
url: https://bashly.dannyb.co/configuration/command/#completions
url: https://bashly.dev/configuration/command/#completions
example: |-
commands:
- name: view
Expand All @@ -88,7 +88,7 @@ command.completions:
command.default:
help: Specify that this sub-command will be executed implicitly.
url: https://bashly.dannyb.co/configuration/command/#default
url: https://bashly.dev/configuration/command/#default
example: |-
# This command will execute when the command line is not
# recognized.
Expand All @@ -106,7 +106,7 @@ command.default:
command.dependencies:
help: Specify a list of required external commands that are needed to run this command.
url: https://bashly.dannyb.co/configuration/command/#dependencies
url: https://bashly.dev/configuration/command/#dependencies
example: |-
# Array syntax
dependencies:
Expand All @@ -128,7 +128,7 @@ command.dependencies:
command.environment_variables:
help: Define a list of environment variables. See `environment_variable` for reference.
url: https://bashly.dannyb.co/configuration/command/#environment_variables
url: https://bashly.dev/configuration/command/#environment_variables
example: |-
environment_variables:
- name: config_path
Expand All @@ -140,7 +140,7 @@ command.environment_variables:
command.examples:
help: Define one or more example messages.
url: https://bashly.dannyb.co/configuration/command/#examples
url: https://bashly.dev/configuration/command/#examples
example: |-
# Use an array of examples for simple one-liners.
examples:
Expand All @@ -159,7 +159,7 @@ command.examples:
command.expose:
help: Specify that the sub-commands of this command should be visible when showing the usage of its parent.
url: https://bashly.dannyb.co/configuration/command/#expose
url: https://bashly.dev/configuration/command/#expose
example: |-
name: cli
commands:
Expand Down Expand Up @@ -190,7 +190,7 @@ command.expose:
command.extensible:
help: Specify that this command can be extended by external means.
url: https://bashly.dannyb.co/configuration/command/#extensible
url: https://bashly.dev/configuration/command/#extensible
example: |-
name: mygit
help: Wrapper for git
Expand All @@ -206,7 +206,7 @@ command.extensible:
command.filename:
help: Specify the path (relative to src) to the partial source code file.
url: https://bashly.dannyb.co/configuration/command/#filename
url: https://bashly.dev/configuration/command/#filename
example: |-
commands:
- name: connect
Expand All @@ -215,7 +215,7 @@ command.filename:
command.filters:
help: Specify a list of custom filter functions that will prevent the command from running unless certain conditions are met.
url: https://bashly.dannyb.co/configuration/command/#filters
url: https://bashly.dev/configuration/command/#filters
example: |-
commands:
- name: container
Expand All @@ -235,7 +235,7 @@ command.filters:
command.flags:
help: Define a list of option flags. See `flag` for reference.
url: https://bashly.dannyb.co/configuration/command/#flags
url: https://bashly.dev/configuration/command/#flags
example: |-
flags:
- long: --purge
Expand All @@ -244,13 +244,13 @@ command.flags:
command.footer:
help: Specify a message to show at the bottom of the help text.
url: https://bashly.dannyb.co/configuration/command/#footer
url: https://bashly.dev/configuration/command/#footer
example: |-
footer: For further help visit https://my.docs-site.com
command.function:
help: Specify a different base function name for this command.
url: https://bashly.dannyb.co/configuration/command/#function
url: https://bashly.dev/configuration/command/#function
example: |-
commands:
- name: container-start
Expand All @@ -271,7 +271,7 @@ command.function:
command.group:
help: Specify the group that this command belongs to.
url: https://bashly.dannyb.co/configuration/command/#group
url: https://bashly.dev/configuration/command/#group
example: |-
command:
name: start
Expand All @@ -280,7 +280,7 @@ command.group:
command.help:
help: Specify the help text to show when displaying usage.
url: https://bashly.dannyb.co/configuration/command/#help
url: https://bashly.dev/configuration/command/#help
example: |-
name: docker
help: Runtime for containers
Expand All @@ -291,7 +291,7 @@ command.help:
command.name:
help: Specify the name of the command. This option is required.
url: https://bashly.dannyb.co/configuration/command/#name
url: https://bashly.dev/configuration/command/#name
example: |-
name: docker
help: Runtime for containers
Expand All @@ -302,7 +302,7 @@ command.name:
command.private:
help: Specify that this command should not be displayed in the help text.
url: https://bashly.dannyb.co/configuration/command/#private
url: https://bashly.dev/configuration/command/#private
example: |-
commands:
- name: completions
Expand All @@ -311,7 +311,7 @@ command.private:
command.variables:
help: Define a list of global bash variables. See `variable` for reference.
url: https://bashly.dannyb.co/configuration/command/#variables
url: https://bashly.dev/configuration/command/#variables
example: |-
variables:
# Simple value
Expand All @@ -332,7 +332,7 @@ command.variables:
command.version:
help: Specify the version to show when running with `--version`.
url: https://bashly.dannyb.co/configuration/command/#version
url: https://bashly.dev/configuration/command/#version
example: |-
name: rush
help: Personal package manager
Expand Down
14 changes: 7 additions & 7 deletions lib/bashly/docs/env.yml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
environment_variable:
help: Define environment variables that will be in use in your script.
url: https://bashly.dannyb.co/configuration/environment-variable/
url: https://bashly.dev/configuration/environment-variable/
example: |-
environment_variables:
- name: config_path
Expand All @@ -12,7 +12,7 @@ environment_variable:
environment_variable.default:
help: Specify the value to apply when not provided by the user.
url: https://bashly.dannyb.co/configuration/environment-variable/#default
url: https://bashly.dev/configuration/environment-variable/#default
example: |-
environment_variables:
- name: config_path
Expand All @@ -21,23 +21,23 @@ environment_variable.default:
environment_variable.help:
help: Specify the help message for this variable.
url: https://bashly.dannyb.co/configuration/environment-variable/#help
url: https://bashly.dev/configuration/environment-variable/#help
example: |-
environment_variables:
- name: api_key
help: Your API key
environment_variable.name:
help: Specify the lowercase name of the variable.
url: https://bashly.dannyb.co/configuration/environment-variable/#name
url: https://bashly.dev/configuration/environment-variable/#name
example: |-
environment_variables:
- name: api_key
help: Your API key
environment_variable.private:
help: Specify that this environment variable should not be advertised in the usage text.
url: https://bashly.dannyb.co/configuration/environment-variable/#private
url: https://bashly.dev/configuration/environment-variable/#private
example: |-
environment_variables:
- name: editor
Expand All @@ -47,7 +47,7 @@ environment_variable.private:
environment_variable.required:
help: Specify that this variable is required.
url: https://bashly.dannyb.co/configuration/environment-variable/#required
url: https://bashly.dev/configuration/environment-variable/#required
example: |-
environment_variables:
- name: api_key
Expand All @@ -57,7 +57,7 @@ environment_variable.required:
environment_variable.validate:
help: Apply custom validation functions.

url: https://bashly.dannyb.co/configuration/environment-variable/#validate
url: https://bashly.dev/configuration/environment-variable/#validate
example: |-
environment_variables:
- name: build_dir
Expand Down
Loading

0 comments on commit d2a38fd

Please sign in to comment.