add an HTTP API
Nadie ha tomado este issue todavía.
Evaluación
- Dificultad
- 5/5
- Tiempo estimado
- Más de una semana
- Aptitud para principiantes
- 42/100
Línea de trabajo
Comienza siguiendo el endpoint /explain existente y cómo analiza los comandos y produce coincidencias de ayuda. Define la respuesta de GET /api/explain?cmd=... usando los campos propuestos help, cmd y matches, incluido el texto de ayuda duplicado y los cambios en los comandos, como el manejo de Unicode. Se considera terminado cuando un endpoint HTTP devuelve el JSON documentado para el ejemplo echo -n y las pruebas de integración adecuadas cubren su comportamiento.
Escrito por el modelo de indexación a partir del texto del issue.
Descripción
It might be time to add an HTTP API for tools/websites that want to integrate with explainshell (issue #4 is one).
My current thought is to add a GET endpoint at /api/explain with a cmd parameter, similar to /explain. The response could be a JSON that looks something like this:
{
'help' : ['help text 0', 'help text 1', ..],
'cmd' : <parsed command>
'matches' : [{'startindex' : x,
'endindex' : y,
'helpindex' : <index into help array, or -1 if unknown>], [..]]
}
The rationale for not inlining the help text into matches is that there can be duplicates. The reason for including cmd in the response is that it's possible for explainshell to change it, e.g. due to unicode which is not supported yet.
Example:
GET /api/explain?cmd=echo -n
{
'help' : ['display a line of text',
'-n do not output the trailing newline'],
'cmd' : 'echo -n'
'matches' : [{'startindex' : 0, 'endindex' : 4, 'helpindex' : 0},
{'startindex' : 5, 'endindex' : 7, 'helpindex' : 1}]
}
- Lenguaje dominante
- Python
- Estrellas
- 14.2k
- Forks
- 851
- Métricas de merge de PR
- Sin PR fusionados en 30 d
Preparar el entorno
Aún no hemos revisado los archivos de configuración de este proyecto. Empieza por su README y consulta nuestra guía para la primera contribución para los pasos generales.
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Más de idank/explainshell
-
`test -s` shows all optionsAbierto
Dificultad 2/5 1-3 horas Aptitud para principiantes 75/100
idank/explainshell#367 ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 65/100
idank/explainshell#365 · 2 comentarios ·
-
Dificultad 4/5 3-5 días Aptitud para principiantes 35/100
idank/explainshell#354 · 2 comentarios · 4 reacciones ·
-
Dificultad 3/5 1-2 días Aptitud para principiantes 45/100
idank/explainshell#343 ·
-
Dificultad 5/5 Más de una semana Aptitud para principiantes 25/100
idank/explainshell#327 ·
Todos los issues de idank/explainshell
Issues similares
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
solana-foundation/pay-kit#341 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 78/100
nasa/python_cmr#123 ·
-
Dificultad 1/5 Menos de una hora Aptitud para principiantes 92/100
EleutherAI/lm-evaluation-harness#4243 ·
Los mantenedores suelen responder en 1 día
-
area: dashboard bug perceived difficulty: 3
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
Nitjsefnie-Harness-Commons/daedalus#1179 ·
Los mantenedores suelen responder en 1 día
-
Dificultad 2/5 1-3 horas Aptitud para principiantes 88/100
cusp-ai-oss/tojax#17 ·