Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix Markdown formatting #67

Merged
merged 2 commits into from
Jan 17, 2019
Merged

Fix Markdown formatting #67

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1a11936
Fix Markdown formatting
mlncn Sep 21, 2018
69597b4
Merge branch 'master' into patch-1
frankcarey Jan 17, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 10 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,17 +27,20 @@ With Ahoy, you can turn this into:
`ahoy mysql-import < some-database.sql`

## FEATURES

- Non-invasive - Use your existing workflow! It can wrap commands and scripts you are already using.
- Consitent - Commands always run relative to the .ahoy.yml file, but can be called from any subfolder.
- Visual - See a list of all of your commands in one place, along with helpful descriptions.
- Flexible - Commands are specific to a single folder tree, so each repo/workspace can have its own commands
- Flexible - Commands are specific to a single folder tree, so each repo/workspace can have its own commands.
- Fully interactive - your shells (like MySQL) and prompts still work.
- Self-Documenting - Commands and help declared in .ahoy.yml show up as ahoy command help and bash completion of commands (see below)
- Self-Documenting - Commands and help declared in .ahoy.yml show up as ahoy command help and bash completion of commands (see below).

## INSTALLATION

### OSX

Using Homebrew:

```
brew tap ahoy-cli/tap
brew install ahoy
Expand All @@ -49,6 +52,7 @@ brew install ahoy --HEAD
```

### Linux

Download and unzip the latest release and move the appropriate binary for your plaform into someplace in your $PATH and rename it `ahoy`.

Example:
Expand All @@ -63,7 +67,7 @@ sudo wget -q https://github.com/ahoy-cli/ahoy/releases/download/2.0.0/ahoy-bin-`
- You can now use a different entrypoint (the thing that runs your commands) instead of bash. Ex. using PHP, Node.js, Python, etc.
- Plugins are now possible by overriding the entrypoint.

###Example of new YAML setup in v2
### Example of new YAML setup in v2

```YAML
# All files must have v2 set or you'll get an error
Expand Down Expand Up @@ -105,10 +109,11 @@ commands:
```

### Planned Features

- Enable specifying specific arguments and flags in the ahoy file itself to cut down on parsing arguments in scripts.
- Support for more built-in commands or a "verify" YAML option that would create a yes / no prompt for potentially destructive commands. (Are you sure you want to delete all your containers?)
- Pipe tab completion to another command (allows you to get tab completion)
- Support for configuration
- Pipe tab completion to another command (allows you to get tab completion).
- Support for configuration.

## Previewing the Read the Docs documentation locally.

Expand Down