An open API service indexing awesome lists of open source software.

https://github.com/proxitystudios/freshland

Freshland is a CLI tool that lets you clone repositories from supported platforms faster and comes with some additinional features such as E.P.A
https://github.com/proxitystudios/freshland

bash bash-script freshland git nodejs repo-cloner repocloner

Last synced: 4 months ago
JSON representation

Freshland is a CLI tool that lets you clone repositories from supported platforms faster and comes with some additinional features such as E.P.A

Awesome Lists containing this project

README

          

# Freshland

Freshland is a CLI tool that lets you clone repositories faster and comes with some additinional features such as E.P.A

## Usage

You can use Freshland in two ways: with a single-line command or with a graphical user interface (GUI).

| Global Flag | Description |
| ---------------- | -------------------------- |
| `--d`, `--debug` | Enable debug mode |
| `--gp`, `--global-proxy` | Globally sets the given proxy |

### Single-line command

To clone a repository with a single-line command, use the following syntax:

```bash
npx freshland@latest clone [FLAGS]
```

For example, to clone `typescript-starter` repository from `ProxityStudios` into a directory named `myapp`, run:

```bash
npx freshland@latest clone ProxityStudios/typescript-starter myapp
```

**<>** Required | **[]** Optional

| Flag | Referance | Accepted Values | Default Value | Description |
| --------------------------- | ------------------ | ---------------------------- | ------------------ | ---------------------------------- |
| `--upd`, `--update-package` | | | `false` | Update package name and version |
| `--i`, `--install-deps` | `` | `npm`, `pnpm`, `bun`, `yarn` | `do-not-install` | Install dependencies automatically |

### Graphical user interface
TODO:

```bash
npx freshland@latest gui
```

You will see a prompt like this:

![With GUI](./docs/assets/with-gui.PNG 'With GUI')

### [BETA] Init E.P.A and automatically configure it

E.P.A stands for **E**SLint, **P**rettier, and **A**irbnb. These are popular tools for code formatting and quality. Freshland can install and configure them for you with a single command. Yeah, it's that simple.

#### TypeScript

If you're using TypeScript, you need to provide the `--ts` flag:

```bash
npx freshland@latest init-epa --ts
```

#### JavaScript

If you're using JavaScript, you don't need to do anything extra, just omit the `--ts` flag.

```bash
npx freshland@latest init-epa
```

| Flag | Description |
| ---------------------- | -------------- |
| `--typescript`, `--ts` | Use TypeScript |

# Support and Feedback

If you have any questions, issues, or feedback related to Freshland, create an issue through Github Issues!