79 lines
1.9 KiB
Markdown
79 lines
1.9 KiB
Markdown
# AGENTS.md
|
|
|
|
## Project Overview
|
|
- **Project**: rscli - Python CLI for a social network API
|
|
- **Entry point**: `rcli` command (defined in pyproject.toml as `rscli.main:app`)
|
|
- **Python version**: >= 3.14
|
|
- **Dependencies**: prettytable, requests, typer
|
|
|
|
## Running the CLI
|
|
```bash
|
|
rcli --help # Show commands
|
|
rcli version # Show version
|
|
rcli login # Login to API
|
|
rcli api_uri <url> # Set API URI
|
|
```
|
|
|
|
## Configuration
|
|
- Config stored at: `~/.config/rs-cli/config.json`
|
|
- Contains: `token`, `API_URI`
|
|
|
|
## Development
|
|
- Install locally: `pip install -e .` or use `uv pip install -e .`
|
|
- Project uses **uv** for dependency management (see uv.lock)
|
|
|
|
## CI/Build
|
|
- Gitea workflows in `.gitea/workflows/build.yml`
|
|
- Builds Arch Linux package (.pkg.tar.zst)
|
|
- Publishes releases to Gitea
|
|
|
|
## Gitea / tea
|
|
|
|
Login to the Gitea instance:
|
|
```bash
|
|
tea login add --name elordenador --url https://git.elordenador.org
|
|
```
|
|
|
|
### Issues
|
|
```bash
|
|
tea issues # List issues
|
|
tea issues create # Create new issue
|
|
tea issues close # Close an issue
|
|
```
|
|
|
|
### Pull Requests
|
|
```bash
|
|
tea pr # List pull requests
|
|
tea pr create # Create PR
|
|
tea pr checkout # Checkout PR locally
|
|
tea pr merge # Merge a PR
|
|
```
|
|
|
|
### Actions (Workflows)
|
|
```bash
|
|
tea actions info # Show workflow info
|
|
tea actions list # List workflow runs
|
|
tea actions logs # View logs for a run
|
|
tea actions re-run # Re-run a failed workflow
|
|
```
|
|
|
|
### Releases
|
|
```bash
|
|
tea release # List releases
|
|
tea release create # Create a release
|
|
```
|
|
|
|
### API
|
|
```bash
|
|
tea api GET /api/v1/repos/RedSocial/cli/releases
|
|
```
|
|
|
|
## Available Skills
|
|
- python-patterns
|
|
- python-testing-patterns
|
|
- python-executor
|
|
|
|
## Notes
|
|
- No test suite currently exists in the repo
|
|
- Config class supports dot-notation paths (e.g., `config.get("token")`)
|
|
- Use `tea` (Gitea CLI) instead of `gh` for Gitea operations |