Skip to content

Commit

Permalink
Update readme file.
Browse files Browse the repository at this point in the history
  • Loading branch information
abhisekmazumdar committed Mar 31, 2023
1 parent 017f25c commit a925ee9
Showing 1 changed file with 41 additions and 8 deletions.
49 changes: 41 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,23 +1,42 @@
# I Don't Know ~ A simple script that knows for you.
# I Don't Know ~ A simple CLI that knows for you.

IDK (I Don't Know) is a command-line tool that simplifies local development with ddev and lando by automatically detecting which one to use for each project.
IDK (I Don't Know) is a CLI that simplifies local development with ddev and lando by automatically detecting which one to use for each project. It can also recognize composer and drush commands in a similar manner.

If you are someone who uses `ddev` & `lando` in your day to day local development workflow and you get confused or don't remember which project you used which for, this script will know for you.
If you are someone who uses `ddev` & `lando` in your day to day local development workflow and you get confused or don't remember which project you used for which, this CLI will know for you.

This is just an initial idea; a lot can be built covering this type of scenario.
Note: Identifying `composer` & `drush` commands are very limited right now.

## Installation
## Install

After cloning this repo, you might need to make the `idk/script.sh` file executable:
### 1. [Download the latest binary](https://github.com/abhisekmazumdar/idk/releases/latest)

### 2. Build binary

- Install Homebrew: https://brew.sh/

- Install go: `brew install go`

- Clone this repo in `$HOME` i.e. `/Users/[user-name]`:

```bash
gh repo clone abhisekmazumdar/idk

cd idk
# Run go build to create the binary file
go build
```

### 3. Go
```bash
chmod +x ~/idk/script.sh
go install github.com/abhisekmazumdar/idk@latest
# The above command will create the binary file in ~/go/bin
```

Then create an alias:

```bash
alias idk="~/idk/script.sh"
alias idk="~/go/bin/idk"
```

Expand All @@ -36,10 +55,24 @@ idk composer instal
# Use it the same way you would have used other commands.
idk ssh
# also, this will run ddev/lando composer install
idk install
# this will run ddev/lando drush site-install
idk site-install
# To know more about the available commands
idk --help
```

Each time you run `idk` like the above said examples, it will show you whether it is using `ddev` or `lando`.

## Known Issues / Missing Features

Its still a Work In Progress tool. I see many corner case yet to cover like flags sometimes doesn't works. If you find any other issues/bugs kindly open an issue in this repo.
## Contributing
Contributions are welcome! To contribute to this project, fork the repository, make your changes, and submit a pull request. For major changes, please open an issue first to discuss what you would like to change.
Expand Down

0 comments on commit a925ee9

Please sign in to comment.